/** * DevExtreme (dx.all.d.ts) * Version: 25.1.7 * Build date: Mon Nov 10 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ declare global { interface JQuery {} interface JQueryEventObject {} interface JQueryPromise {} } 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 { 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( optionName: TPropertyName ): TPropertyName extends keyof TProperties ? TProperties[TPropertyName] : unknown; /** * Updates the value of a single property. */ option( optionName: TPropertyName, optionValue: TPropertyName extends keyof TProperties ? TProperties[TPropertyName] : unknown ): void; /** * Updates the values of several properties. */ option(options: Partial): 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 = { device?: | DevExpress.common.core.environment.Device | DevExpress.common.core.environment.Device[] | ((device: DevExpress.common.core.environment.Device) => boolean); options: DevExpress.core.DeepPartial; }; /** * 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 { _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; /** * Specifies the device-dependent default configuration properties for this component. */ static defaultOptions( rule: DefaultOptionsRule ): 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; _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 {} /** * @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 = DevExpress.common.core.events.EventInfo & 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. */ type Properties = DOMComponentOptions; } /** * * @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 extends ComponentOptions< DevExpress.common.core.events.EventInfo, DevExpress.common.core.events.InitializedEventInfo, DevExpress.DOMComponent.OptionChangedEventInfo > { /** * 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 ) => void; /** * A function that is executed after a UI component property is changed. */ onOptionChanged?: ( e: DevExpress.DOMComponent.OptionChangedEventInfo ) => 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 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; } 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( name: string, componentClass: DevExpress.core.ComponentFactory ): 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( name: string, namespace: { [key: string]: DevExpress.core.ComponentFactory; }, componentClass: DevExpress.core.ComponentFactory ): 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 { /** * @docid * @param provider */ constructor(provider: AIProvider); changeStyle( params: ChangeStyleCommandParams, callbacks: RequestCallbacks ): () => void; changeTone( params: ChangeToneCommandParams, callbacks: RequestCallbacks ): () => void; execute( params: ExecuteCommandParams, callbacks: RequestCallbacks ): () => void; expand( params: ExpandCommandParams, callbacks: RequestCallbacks ): () => void; proofread( params: ProofreadCommandParams, callbacks: RequestCallbacks ): () => void; shorten( params: ShortenCommandParams, callbacks: RequestCallbacks ): () => void; summarize( params: SummarizeCommandParams, callbacks: RequestCallbacks ): () => void; translate( params: TranslateCommandParams, callbacks: RequestCallbacks ): () => void; } /** * 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; }; /** * @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 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; /** * 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 = { 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; }; /** * An object returned by the sendRequest function. */ export type Response = { /** * A promise that resolves with the final AI-generated text. */ promise: Promise; /** * 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 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; }; 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 return value is used for comparison with the validated value. */ comparisonTarget?: () => any; /** * Specifies the operator to be used for comparing the validated value with the target. */ comparisonType?: ComparisonOperator; /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the rule type. Set it to 'compare' to use the CompareRule. */ type: 'compare'; }; export type ComparisonOperator = | '!=' | '!==' | '<' | '<=' | '==' | '===' | '>' | '>='; /** * A rule with custom validation logic. */ export type CustomRule = { /** * 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 be always checked for the target value or only when the target value changes. */ reevaluate?: boolean; /** * Specifies the rule type. Set it to 'custom' to use the CustomRule. */ type: 'custom'; /** * A function that validates the target value. */ validationCallback?: (options: ValidationCallbackData) => 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. */ type DataSourceEventName = 'changed' | 'loadError' | 'loadingChanged'; export type DataStructure = 'plain' | 'tree'; export type DataType = | 'string' | 'number' | 'date' | 'boolean' | 'object' | 'datetime'; export type DateLike = Date | number | string | null; export type Direction = 'bottom' | 'left' | 'right' | 'top'; export type DisplayMode = 'adaptive' | 'compact' | 'full'; export type DragDirection = 'both' | 'horizontal' | 'vertical'; export type Draggable = DevExpress.core.OmitInternal; export type DragHighlight = 'push' | 'indicate'; export type EditorStyle = 'outlined' | 'underlined' | 'filled'; /** * A validation rule that requires that the validated field match the Email pattern. */ export type EmailRule = { /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the rule type. Set it to 'email' to use the EmailRule. */ type: 'email'; }; /** * @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. */ type EventName = 'orientationChanged'; export type ExportFormat = 'GIF' | 'JPEG' | 'PDF' | 'PNG' | 'SVG'; /** * @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. */ type ExternalFormat = Intl.DateTimeFormatOptions | Intl.NumberFormatOptions; export type FieldChooserLayout = 0 | 1 | 2; export type FirstDayOfWeek = 0 | 1 | 2 | 3 | 4 | 5 | 6; export type Format = | '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'; /** * @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 FormatObject { /** * Specifies a 3-letter ISO 4217 code for currency. Applies only if the type is 'currency'. */ currency?: string; /** * Specifies whether to apply the accounting style to formatted numbers of the `currency` type. */ useCurrencyAccountingStyle?: boolean; /** * 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; } /** * Specifies settings that affect all DevExtreme UI components. */ export type GlobalConfig = { versionAssertions?: VersionAssertion[]; /** * A decimal separator. No longer applies. * @deprecated */ decimalSeparator?: string; /** * The default currency. Accepts a 3-letter ISO 4217 code. */ defaultCurrency?: string; /** * Specifies whether to apply the accounting style to formatted numbers of the `currency` type. */ defaultUseCurrencyAccountingStyle?: boolean; /** * Specifies whether to copy DevExtreme stylesheets into the Shadow DOM. */ copyStylesToShadowDom?: boolean; /** * Specifies how editors' text fields are styled in your application. */ editorStylingMode?: EditorStyle | undefined; /** * 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?: FloatingActionButtonDirection; /** * 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?: | PositionAlignment | DevExpress.common.core.animation.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; /** * @deprecated Attention! This field is not documented and should only be specified in a limited number of use cases. For more information, please submit a ticket to our Support Center. */ pointerEventStrategy?: 'mouse-and-touch' | 'mouse' | 'touch'; /** * @deprecated Attention! This field is not documented and should only be specified in a limited number of use cases. For more information, please submit a ticket to our Support Center. */ timezones?: unknown[]; /** * 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; /** * A license key. */ licenseKey?: string; buyNowLink?: string; licensingDocLink?: string; }; export type HorizontalAlignment = 'center' | 'left' | 'right'; export type HorizontalEdge = 'left' | 'right'; /** * @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 HttpMethod = 'GET' | 'POST' | 'PATCH' | 'MERGE'; export type LabelMode = 'static' | 'floating' | 'hidden' | 'outside'; /** * @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. */ type LoadFunctionResult = | T | DevExpress.core.utils.DxPromise | PromiseLike; /** * @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. */ type LoadResultArray = | Array | Array>; export type MaskMode = 'always' | 'onFocus'; export type Mode = 'auto'; /** * A validation rule that demands that the validated field has a numeric value. */ export type NumericRule = { /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the rule type. Set it to 'numeric' to use the NumericRule. */ type: 'numeric'; }; /** * @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 ODataRequestOptions { accepts: any; async: boolean; contentType: string | boolean; data: any; dataType: string; headers: any; jsonp?: boolean; method: string; timeout: number; url: string; xhrFields: any; } export type Orientation = 'horizontal' | 'vertical'; export type PageLoadMode = 'nextButton' | 'scrollBottom'; export type PageOrientation = 'portrait' | 'landscape'; /** * * @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 PagerBase = { /** * Specifies the pager's display mode. */ displayMode?: DisplayMode; /** * Specifies the page information text. */ infoText?: string; /** * Specifies whether to show the page information. */ showInfo?: boolean; /** * Specifies whether to show navigation buttons. */ showNavigationButtons?: boolean; /** * Specifies page size selector visibility. */ showPageSizeSelector?: boolean | Mode; /** * Specifies an aria-label attribute for the pager. */ label?: string; }; /** * A validation rule that requires that the validated field match a specified pattern. */ export type PatternRule = { /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the regular expression that the validated value must match. */ pattern?: RegExp | string; /** * Specifies the rule type. Set it to 'pattern' to use the PatternRule. */ type: 'pattern'; }; export type Position = 'bottom' | 'left' | 'right' | 'top'; export type PositionAlignment = | 'bottom' | 'center' | 'left' | 'left bottom' | 'left top' | 'right' | 'right bottom' | 'right top' | 'top'; /** * @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. */ type PredefinedFormat = Format; /** * A validation rule that demands the target value be within the specified value range (including the range's end points). */ export type RangeRule = { /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the maximum value allowed for the validated value. */ max?: Date | number | string; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the minimum value allowed for the validated value. */ min?: Date | number | string; /** * Indicates whether the rule should be always checked for the target value or only when the target value changes. */ reevaluate?: boolean; /** * Specifies the rule type. Set it to 'range' to use the RangeRule. */ type: 'range'; }; /** * @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 ReducedNativeEventInfo< TComponent extends DevExpress.common.grids.GridBase > = Required< Pick< DevExpress.common.core.events.NativeEventInfo< TComponent, DevExpress.events.PointerInteractionEvent >, 'component' | 'event' > >; /** * A validation rule that rejects empty and invalid values. */ export type RequiredRule = { /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Indicates whether to remove the Space characters from the validated value. */ trim?: boolean; /** * Specifies the rule type. Set it to 'required' to use the RequiredRule. */ type: 'required'; }; export type Scrollable = DevExpress.core.OmitInternal; export type ScrollbarMode = 'always' | 'never' | 'onHover' | 'onScroll'; export type ScrollDirection = 'both' | 'horizontal' | 'vertical'; export type ScrollMode = 'standard' | 'virtual'; export type SearchMode = 'contains' | 'startswith' | 'equals'; export type SelectAllMode = 'allPages' | 'page'; export type SimplifiedSearchMode = 'contains' | 'startswith'; export type SingleMultipleAllOrNone = 'single' | 'multiple' | 'all' | 'none'; export type SingleMultipleOrNone = 'single' | 'multiple' | 'none'; export type SingleOrMultiple = 'single' | 'multiple'; export type SingleOrNone = 'single' | 'none'; export type SliderValueChangeMode = 'onHandleMove' | 'onHandleRelease'; export type Sortable = DevExpress.core.OmitInternal; export type SortOrder = 'asc' | 'desc'; export type StoreType = 'array' | 'local' | 'odata'; /** * A validation rule that demands the target value length be within the specified value range (including the range's end points). */ export type StringLengthRule = { /** * If set to true, empty values are valid. */ ignoreEmptyValue?: boolean; /** * Specifies the maximum length allowed for the validated value. */ max?: number; /** * Specifies the message that is shown if the rule is broken. */ message?: string; /** * Specifies the minimum length allowed for the validated value. */ min?: number; /** * Indicates whether or not to remove the Space characters from the validated value. */ trim?: boolean; /** * Specifies the rule type. Set it to 'stringLength' to use the StringLengthRule. */ type: 'stringLength'; }; export type SubmenuShowMode = 'onClick' | 'onHover'; export type TabsIconPosition = 'top' | 'end' | 'bottom' | 'start'; export type TabsStyle = 'primary' | 'secondary'; export type TextBoxPredefinedButton = 'clear'; /** * */ export type TextEditorButton = { /** * Specifies whether to place the button before or after the input text field. */ location?: TextEditorButtonLocation; /** * Specifies the button's name. */ name?: string | undefined; /** * Configures the Button UI component used as the action button. */ options?: DevExpress.ui.dxButton.Properties | undefined; }; export type TextEditorButtonLocation = 'after' | 'before'; export type ToolbarItemComponent = | 'dxAutocomplete' | 'dxButton' | 'dxButtonGroup' | 'dxCheckBox' | 'dxDateBox' | 'dxDropDownButton' | 'dxMenu' | 'dxSelectBox' | 'dxSwitch' | 'dxTabs' | 'dxTextBox'; export type ToolbarItemLocation = 'after' | 'before' | 'center'; export type TooltipShowMode = 'always' | 'onHover'; export type ValidationCallbackData = { value?: any; rule: any; validator: any; data?: any; column?: any; formItem?: any; }; export type ValidationMessageMode = 'always' | 'auto'; /** * Specifies a validation rule. */ export type ValidationRule = | AsyncRule | CompareRule | CustomRule | EmailRule | NumericRule | PatternRule | RangeRule | RequiredRule | StringLengthRule; export type ValidationRuleType = | 'required' | 'numeric' | 'range' | 'stringLength' | 'custom' | 'compare' | 'pattern' | 'email' | 'async'; export type ValidationStatus = 'valid' | 'invalid' | 'pending'; export type VerticalAlignment = 'bottom' | 'center' | 'top'; export type VerticalEdge = 'bottom' | 'top'; } declare module DevExpress.common.charts { export type AnimationEaseMode = 'easeOutCubic' | 'linear'; export type AnnotationType = 'text' | 'image' | 'custom'; export type ArgumentAxisHoverMode = 'allArgumentPoints' | 'none'; export type AxisScaleType = 'continuous' | 'discrete' | 'logarithmic'; /** * * @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 BaseLegend { /** * Colors the legend's background. */ backgroundColor?: string | undefined; /** * Configures the legend's border. */ border?: { /** * Colors the legend's border. */ color?: string; /** * Makes all the legend's corners rounded. */ cornerRadius?: number; /** * Sets a dash style for the legend's border. */ dashStyle?: DashStyle; /** * Specifies the transparency of the legend's border. */ opacity?: number | undefined; /** * Shows the legend's border. */ visible?: boolean; /** * Specifies the width of the legend's border in pixels. */ width?: number; }; /** * Arranges legend items into several columns. */ columnCount?: number; /** * Specifies an empty space between item columns in pixels. */ columnItemSpacing?: number; /** * Specifies the legend items' font properties. */ font?: Font; /** * Along with verticalAlignment, specifies the legend's position. */ horizontalAlignment?: HorizontalAlignment; /** * Specifies the text's position relative to the marker in a legend item. */ itemTextPosition?: Position | undefined; /** * Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally. */ itemsAlignment?: HorizontalAlignment | undefined; /** * Generates an empty space, measured in pixels, around the legend. */ margin?: | number | { /** * Specifies the legend's bottom margin in pixels. */ bottom?: number; /** * Specifies the legend's left margin in pixels. */ left?: number; /** * Specifies the legend's right margin in pixels. */ right?: number; /** * Specifies the legend's top margin in pixels. */ top?: number; }; /** * Specifies the marker's size in a legend item in pixels. */ markerSize?: number; /** * Arranges legend items vertically (in a column) or horizontally (in a row). The default value is 'horizontal' if the legend.horizontalAlignment is 'center'. Otherwise, it is 'vertical'. */ orientation?: Orientation | undefined; /** * Generates an empty space, measured in pixels, between the legend's left/right border and its items. */ paddingLeftRight?: number; /** * Generates an empty space, measured in pixels, between the legend's top/bottom border and its items. */ paddingTopBottom?: number; /** * Arranges legend items in several rows. */ rowCount?: number; /** * Specifies an empty space between item rows in pixels. */ rowItemSpacing?: number; /** * Configures the legend title. */ title?: | { /** * Specifies the legend title's font properties. */ font?: Font; /** * Along with verticalAlignment, specifies the legend title's position. */ horizontalAlignment?: HorizontalAlignment | undefined; /** * Generates space around the legend title. */ margin?: { /** * Specifies the legend title's bottom margin. */ bottom?: number; /** * Specifies the legend title's left margin. */ left?: number; /** * Specifies the legend title's right margin. */ right?: number; /** * Specifies the legend title's top margin. */ top?: number; }; /** * Reserves a pixel-measured space for the legend title. */ placeholderSize?: number | undefined; /** * Configures the legend subtitle. The subtitle appears only if the title is specified. */ subtitle?: | { /** * Specifies the legend subtitle's font properties. */ font?: Font; /** * Specifies the distance between the legend's title and subtitle in pixels. */ offset?: number; /** * Specifies the subtitle's text. */ text?: string; } | string; /** * Specifies the legend title's text. */ text?: string; /** * Specifies the legend title's vertical alignment. */ verticalAlignment?: VerticalEdge; } | string; /** * Along with horizontalAlignment, specifies the legend's position. */ verticalAlignment?: VerticalEdge; /** * Specifies the legend's visibility. */ visible?: 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 interface BaseLegendItem { /** * A legend item marker. */ marker?: { /** * The marker's color. */ fill?: string; /** * The marker's opacity. */ opacity?: number; /** * The markerSize in pixels. */ size?: number; /** * The marker's state. */ state?: LegendMarkerState; }; /** * The text that the legend item displays. */ text?: string; /** * Indicates and specifies whether the legend item is visible. */ visible?: boolean; } export type ChartsAxisLabelOverlap = 'rotate' | 'stagger' | 'none' | 'hide'; /** * Specifies the chart's color. */ export type ChartsColor = { /** * Specifies the base color for series, points and labels. */ base?: string | undefined; /** * Specifies the id of the gradient or pattern. */ fillId?: string | undefined; }; export type ChartsDataType = 'datetime' | 'numeric' | 'string'; export type ChartsLabelOverlap = 'hide' | 'none' | 'stack'; export type DashStyle = 'dash' | 'dot' | 'longDash' | 'solid'; export type DiscreteAxisDivisionMode = 'betweenLabels' | 'crossLabels'; /** * Font properties. */ export type Font = { /** * Specifies font color. */ color?: string; /** * Specifies font family. */ family?: string; /** * Specifies font opacity. */ opacity?: number; /** * Specifies font size. */ size?: string | number; /** * Specifies font weight. Accepts values from 100 to 900 in increments of 100. Higher values increase boldness. */ weight?: number; }; /** * Specifies colors on which gradient is based. */ export type GradientColor = { /** * Specifies the starting point of a color. */ offset: number | string | undefined; /** * Specifies one of the gradient colors. */ color: string | undefined; }; export type HatchDirection = 'left' | 'none' | 'right'; export type LabelOverlap = 'hide' | 'none'; export type LabelPosition = 'columns' | 'inside' | 'outside'; export type LegendHoverMode = 'excludePoints' | 'includePoints' | 'none'; /** * An object that provides information about a legend item. */ export interface LegendItem extends BaseLegendItem { /** * The series that the item represents on the legend. */ series?: DevExpress.viz.baseSeriesObject; } export type LegendMarkerState = 'normal' | 'hovered' | 'selected'; export type Palette = | 'Bright' | 'Harmony Light' | 'Ocean' | 'Pastel' | 'Soft' | 'Soft Pastel' | 'Vintage' | 'Violet' | 'Carmine' | 'Dark Moon' | 'Dark Violet' | 'Green Mist' | 'Soft Blue' | 'Material' | 'Office'; export type PaletteColorSet = 'simpleSet' | 'indicatingSet' | 'gradientSet'; export type PaletteExtensionMode = 'alternate' | 'blend' | 'extrapolate'; export type PointInteractionMode = | 'allArgumentPoints' | 'allSeriesPoints' | 'none' | 'onlyPoint'; export type PointSymbol = | 'circle' | 'cross' | 'polygon' | 'square' | 'triangle' | 'triangleDown' | 'triangleUp'; /** * Registers a new gradient. */ export function registerGradient( type: string, options: { rotationAngle?: number; colors: Array } ): string; /** * Registers a new pattern. */ export function registerPattern(options: { width: number | string; height: number | string; template: (container: SVGGElement) => void; }): string; export type RelativePosition = 'inside' | 'outside'; /** * A class describing a scale break range. Inherited by scale breaks in the Chart and RangeSelector. */ export type ScaleBreak = { /** * Along with the startValue property, limits the scale break. */ endValue?: number | Date | string | undefined; /** * Along with the endValue property, limits the scale break. */ startValue?: number | Date | string | undefined; }; export type ScaleBreakLineStyle = 'straight' | 'waved'; export type SeriesHoverMode = | 'allArgumentPoints' | 'allSeriesPoints' | 'excludePoints' | 'includePoints' | 'nearestPoint' | 'none' | 'onlyPoint'; export interface SeriesLabel { /** * Aligns point labels in relation to their points. */ alignment?: HorizontalAlignment; /** * Formats the point argument before it is displayed in the point label. To format the point value, use the format property. */ argumentFormat?: DevExpress.common.core.localization.Format | undefined; /** * Colors the point labels' background. The default color is inherited from the points. */ backgroundColor?: string | undefined; /** * Configures the borders of point labels. */ border?: { /** * Colors the border. */ color?: string | undefined; /** * Specifies the dash style of the border. */ dashStyle?: DashStyle | undefined; /** * Makes the border visible. */ visible?: boolean; /** * Specifies the width of the border in pixels. */ width?: number; }; /** * Configures the label connectors. */ connector?: { /** * Colors the connectors. */ color?: string | undefined; /** * Makes the connectors visible. Applies only if label.visible is set to true. */ visible?: boolean; /** * Specifies the width of the connectors in pixels. */ width?: number; }; /** * Customizes text displayed by point labels. */ customizeText?: (pointInfo: any) => string; /** * Specifies font properties for point labels. */ font?: Font; /** * Formats the point value before it is displayed in the point label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Along with verticalOffset, shifts point labels from their initial positions. */ horizontalOffset?: number; /** * Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series. */ position?: RelativePosition; /** * Rotates point labels. */ rotationAngle?: number; /** * Specifies whether or not to show labels for points with zero value. Applies only to bar-like series. */ showForZeroValues?: boolean; /** * Along with horizontalOffset, shifts point labels from their initial positions. */ verticalOffset?: number; /** * Makes the point labels visible. */ visible?: boolean; /** * Specifies the label's text. */ displayFormat?: string | undefined; } export interface SeriesPoint { /** * Configures the appearance of the series point border in scatter, line- and area-like series. */ border?: { /** * Colors the border. */ color?: string | undefined; /** * Makes the border visible. */ visible?: boolean; /** * Sets the width of the border in pixels. */ width?: number; }; /** * Colors the series points. */ color?: string | ChartsColor | undefined; /** * Specifies series elements to be highlighted when a user pauses on a series point. */ hoverMode?: PointInteractionMode; /** * Configures the appearance adopted by a series point when a user pauses on it. */ hoverStyle?: { /** * Configures the appearance of the point border when a user pauses on the point. */ border?: { /** * Specifies the color of the point border when the point is in the hovered state. */ color?: string | undefined; /** * Makes the border visible when a user pauses on the series point. */ visible?: boolean; /** * Specifies the width of the point border when the point is in the hovered state. */ width?: number; }; /** * Specifies the color of series points in the hovered state. */ color?: string | ChartsColor | undefined; /** * Specfies the diameter of series points in the hovered state. */ size?: number | undefined; }; /** * Substitutes the standard point symbols with an image. */ image?: | string | undefined | { /** * Specifies the height of the image used instead of a point marker. */ height?: | number | { /** * Specifies the height of the image that represents the maximum point in a range area series. */ rangeMaxPoint?: number | undefined; /** * Specifies the height of the image that represents the minimum point in a range area series. */ rangeMinPoint?: number | undefined; }; /** * Specifies the URL of the image to be used as a point marker. */ url?: | string | undefined | { /** * Specifies the URL of the image to be used as a maximum point marker. */ rangeMaxPoint?: string | undefined; /** * Specifies the URL of the image to be used as a maximum point marker. */ rangeMinPoint?: string | undefined; }; /** * Specifies the width of an image that is used as a point marker. */ width?: | number | { /** * Specifies the width of the image that represents the maximum point in a range area series. */ rangeMaxPoint?: number | undefined; /** * Specifies the width of the image that represents the minimum point in a range area series. */ rangeMinPoint?: number | undefined; }; }; /** * Specifies series elements to be highlighted when a user selects a series point. */ selectionMode?: PointInteractionMode; /** * Configures the appearance of a selected series point. */ selectionStyle?: { /** * Configures the border of a selected point. */ border?: { /** * Specifies the color of the point border when the point is selected. */ color?: string | undefined; /** * Makes the border of a selected point visible. */ visible?: boolean; /** * Specifies the width of the point border when the point is selected. */ width?: number; }; /** * Specifies the color of series points in the selected state. */ color?: string | ChartsColor | undefined; /** * Specfies the diameter of series points in the selected state. */ size?: number | undefined; }; /** * Specifies the diameter of series points in pixels. */ size?: number; /** * Specifies which symbol should represent series points in scatter, line- and area-like series. */ symbol?: PointSymbol; /** * Makes the series points visible. */ visible?: boolean; } export type SeriesSelectionMode = | 'allArgumentPoints' | 'allSeriesPoints' | 'excludePoints' | 'includePoints' | 'none' | 'onlyPoint'; export type SeriesType = | 'area' | 'bar' | 'bubble' | 'candlestick' | 'fullstackedarea' | 'fullstackedbar' | 'fullstackedline' | 'fullstackedspline' | 'fullstackedsplinearea' | 'line' | 'rangearea' | 'rangebar' | 'scatter' | 'spline' | 'splinearea' | 'stackedarea' | 'stackedbar' | 'stackedline' | 'stackedspline' | 'stackedsplinearea' | 'steparea' | 'stepline' | 'stock'; export type ShiftLabelOverlap = 'hide' | 'none' | 'shift'; export type TextOverflow = 'ellipsis' | 'hide' | 'none'; export type Theme = | 'generic.dark' | 'generic.light' | 'generic.contrast' | 'generic.carmine' | 'generic.darkmoon' | 'generic.darkviolet' | 'generic.greenmist' | 'generic.softblue' | 'material.blue.light' | 'material.lime.light' | 'material.orange.light' | 'material.purple.light' | 'material.teal.light'; export type TimeInterval = | 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'; /** * A class describing various time intervals. Inherited by tick intervals in Chart and RangeSelector. */ export type TimeIntervalConfig = | number | { /** * Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values. */ days?: number; /** * Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values. */ hours?: number; /** * Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values. */ milliseconds?: number; /** * Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values. */ minutes?: number; /** * Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values. */ months?: number; /** * Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values. */ quarters?: number; /** * Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values. */ seconds?: number; /** * Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values. */ weeks?: number; /** * Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values. */ years?: number; } | TimeInterval | undefined; export type ValueAxisVisualRangeUpdateMode = 'auto' | 'keep' | 'reset'; export type ValueErrorBarDisplayMode = 'auto' | 'high' | 'low' | 'none'; export type ValueErrorBarType = | 'fixed' | 'percent' | 'stdDeviation' | 'stdError' | 'variance'; /** * */ export type VisualRange = { /** * The range's end value. */ endValue?: number | Date | string | undefined; /** * The range's length. */ length?: TimeIntervalConfig; /** * The range's start value. */ startValue?: number | Date | string | undefined; }; export type VisualRangeUpdateMode = 'auto' | 'keep' | 'reset' | 'shift'; export type WordWrap = 'normal' | 'breakWord' | 'none'; export type ZoomPanAction = 'zoom' | 'pan'; } declare module DevExpress.common.core.animation { /** * 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?: Direction | undefined; /** * 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?: AnimationState; /** * A number specifying the time period to wait before the animation of the next stagger item starts. */ staggerDelay?: number | undefined; /** * 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?: AnimationState; /** * A string value specifying the animation type. */ type?: AnimationType; }; /** * 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?: DevExpress.common.core.environment.Device; } ): void; /** * Deletes all custom animations. */ resetToDefaults(): void; }; /** * Describes an animation state. */ export type AnimationState = | string | number | { /** * Element opacity. */ opacity: number; } | { /** * A value that controls element size. */ scale: number; } | { /** * Element position. */ position: PositionConfig; } | { /** * A shortcut that positions the element's left side relative to the parent element. */ left: number; } | { /** * A shortcut that positions the element's top side relative to the parent element. */ top: number; }; /** * Cancels an animation frame request scheduled with the requestAnimationFrame method. */ export function cancelAnimationFrame(requestID: number): void; export type CollisionResolution = 'fit' | 'flip' | 'flipfit' | 'none'; export type CollisionResolutionCombination = | 'fit' | 'fit flip' | 'fit flipfit' | 'fit none' | 'flip' | 'flip fit' | 'flip none' | 'flipfit' | 'flipfit fit' | 'flipfit none' | 'none' | 'none fit' | 'none flip' | 'none flipfit'; /** * 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; /** * Checks whether an element is being animated. */ isAnimating(element: Element): boolean; /** * Stops an element's animation. */ stop(element: Element, jumpToEnd: boolean): void; }; /** * Configures the position of an overlay element. */ export type PositionConfig = { /** * Specifies the target element's side or corner where the overlay element should be positioned. */ at?: | PositionAlignment | { /** * Specifies a position in the horizontal direction (for left, right, or center alignment). */ x?: HorizontalAlignment; /** * Specifies a position in the vertical direction (for top, bottom, or center alignment). */ y?: VerticalAlignment; }; /** * 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?: | CollisionResolutionCombination | { /** * Specifies how to resolve horizontal collisions. */ x?: CollisionResolution; /** * Specifies how to resolve vertical collisions. */ y?: CollisionResolution; }; /** * Specifies the overlay element's side or corner to align with a target element. */ my?: | PositionAlignment | { /** * Specifies a position in the horizontal direction (for left, right, or center alignment). */ x?: HorizontalAlignment; /** * Specifies a position in the vertical direction (for top, bottom, or center alignment). */ y?: VerticalAlignment; }; /** * 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; }; }; /** * Makes the browser call a function to update animation before the next repaint. */ export function requestAnimationFrame(callback: Function): number; /** * 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; /** * Stops all started animations. */ stop(): void; } } declare module DevExpress.common.core.environment { /** * 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; }; /** * */ export const devices: DevExpress.core.DevicesObject; /** * Gets a list of time zone objects from the IANA time zone database. */ export function getTimeZones( date?: Date, timeZones?: string[] ): Array; /** * Hides the last displayed overlay UI component. */ export function hideTopOverlay(): boolean; /** * Sets parameters for the viewport meta tag. Takes effect for mobile applications only. */ export function initMobileViewport(options: { allowZoom?: boolean; allowPan?: boolean; allowSelection?: boolean; }): void; /** * A time zone object. */ export type SchedulerTimeZone = { /** * 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; }; } declare module DevExpress.common.core.events { /** * */ export type AsyncCancelable = { /** * */ cancel: boolean | PromiseLike; }; /** * A type used in events. Specifies whether the event is cancelable. */ export type Cancelable = { /** * Specifies whether the event is cancelable. */ cancel?: boolean; }; /** * Specifies arguments of `optionChanged` event. */ export type ChangedOptionInfo = { /** * The modified property if it belongs to the first level. Otherwise, the first-level property into which it is nested. */ readonly name: string; /** * The path to the modified property that includes all parent properties. */ readonly fullName: string; /** * The modified property's new value. */ readonly value?: any; /** * The UI component's previous value. */ readonly previousValue?: any; }; /** * A type that contains fields common for all events (`component`, `element`, `model`). */ export type EventInfo = { /** * The UI component's instance. */ readonly component: TComponent; /** * The UI component's container. */ readonly element: DevExpress.core.DxElement; /** * Model data. Available only if you use Knockout. */ readonly model?: any; }; export type EventObject = DevExpress.events.EventObject; /** * Specifies arguments of `initialized` event. */ export type InitializedEventInfo = { /** * The UI component's instance. */ readonly component?: TComponent; /** * The UI component's container. */ readonly element?: DevExpress.core.DxElement; }; /** * Specifies item information used in events related to a component's items. */ export type ItemInfo = { /** * The item's data. */ readonly itemData?: TItemData; /** * The item's container. */ readonly itemElement: DevExpress.core.DxElement; /** * The item's index. */ readonly itemIndex: number; }; /** * A type that contains fields common for all events (`component`, `element`, `model`) and the `event` field. */ export type NativeEventInfo = { /** * The UI component's instance. */ readonly component: TComponent; /** * The UI component's container. */ readonly element: DevExpress.core.DxElement; /** * Model data. Available only if you use Knockout. */ readonly model?: any; /** * A native browser event with additional fields from `EventObject`. */ readonly event?: DevExpress.events.DxEvent; }; /** * Detaches all handlers from the specified elements. */ export function off(element: Element | Array): void; /** * Detaches all handlers of the specified event from the specified elements. */ export function off( element: Element | Array, eventName: string ): void; /** * Detaches an event handler from the specified elements. */ export function off( element: Element | Array, eventName: string, handler: Function ): void; /** * Detaches all event handlers of the specified type attached using the on(element, eventName, selector, data, handler) or on(element, eventName, selector, handler) method. */ export function off( element: Element | Array, eventName: string, selector: string ): void; /** * Detaches the specified event handler attached using the on(element, eventName, selector, data, handler) or on(element, eventName, selector, handler) method. */ export function off( element: Element | Array, eventName: string, selector: string, handler: Function ): void; /** * Attaches an event handler to the specified elements. Allows you to pass custom data to the handler. */ export function on( element: Element | Array, eventName: string, data: any, handler: Function ): void; /** * Attaches an event handler to the specified elements. */ export function on( element: Element | Array, eventName: string, handler: Function ): void; /** * Attaches an event handler to the specified elements' descendants. Allows you to pass custom data to the handler. */ export function on( element: Element | Array, eventName: string, selector: string, data: any, handler: Function ): void; /** * Attaches an event handler to the specified elements' descendants. */ export function on( element: Element | Array, eventName: string, selector: string, handler: Function ): void; /** * Attaches an event handler that is executed only once to the specified elements. Allows you to pass custom data to the handler. */ export function one( element: Element | Array, eventName: string, data: any, handler: Function ): void; /** * Attaches an event handler that is executed only once to the specified elements. */ export function one( element: Element | Array, eventName: string, handler: Function ): void; /** * Attaches an event handler that is executed only once to the specified elements' descendants. Allows you to pass custom data to the handler. */ export function one( element: Element | Array, eventName: string, selector: string, data: any, handler: Function ): void; /** * Attaches an event handler that is executed only once to the specified elements' descendants. */ export function one( element: Element | Array, eventName: string, selector: string, handler: Function ): void; /** * Triggers an event for the specified elements. */ export function trigger( element: Element | Array, event: string | DevExpress.events.DxEvent ): void; /** * Triggers an event for the specified elements. Allows you to pass custom parameters to event handlers. */ export function trigger( element: Element | Array, event: string | DevExpress.events.DxEvent, extraParameters: any ): void; } declare module DevExpress.common.core.localization { /** * Formats values. */ export type Format = | FormatObject | PredefinedFormat | string | ((value: number | Date) => string) | ((value: Date) => string) | ((value: number) => string) | ExternalFormat | undefined; /** * Converts a Date object to a string using the specified format. */ export function formatDate(value: Date, format: Format): string; /** * Substitutes the provided value(s) for placeholders in a message that the key specifies. */ export function formatMessage(key: string, ...values: Array): string; /** * Converts a numeric value to a string using the specified format. */ export function formatNumber(value: number, format: Format): string; /** * Loads localized messages. */ export function loadMessages(messages: any): void; /** * Gets the current locale identifier. */ export function locale(): string; /** * Sets the current locale identifier. */ export function locale(locale: string): void; /** * Parses a string into a Date object. */ export function parseDate(text: string, format: Format): Date; /** * Parses a string into a numeric value. */ export function parseNumber(text: string, format: Format): number; } declare module DevExpress.common.data { /** * @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 AbstractStore extends Store< TItem, TKey > { constructor( options?: DevExpress.common.data.AbstractStore.Options ); /** * Starts loading data. */ load(): DevExpress.core.utils.DxExtendedPromise>; /** * Starts loading data. */ load( options: LoadOptions ): DevExpress.core.utils.DxExtendedPromise>; } module AbstractStore { /** * @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 Options = AbstractStoreOptions< TItem, TKey >; } /** * @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 AbstractStoreOptions extends StoreOptions { /** * A function that is executed after data is loaded to the store. */ onLoaded?: (result: Array, loadOptions: LoadOptions) => void; } /** * Applies an array of changes to a source data array. */ export function applyChanges( data: Array, changes: Array, options?: { keyExpr?: string | Array; immutable?: boolean } ): Array; /** * The ArrayStore is a store that provides an interface for loading and editing an in-memory array and handling related events. */ export class ArrayStore extends AbstractStore< TItem, TKey > { constructor(options?: ArrayStoreOptions); /** * Gets a data item with a specific key. */ byKey(key: TKey): DevExpress.core.utils.DxPromise; /** * Clears all the ArrayStore's associated data. */ clear(): void; /** * Creates a Query for the underlying array. */ createQuery(): Query; } /** * */ export type ArrayStoreOptions = AbstractStoreOptions< TItem, TKey > & { /** * Specifies the store's associated array. */ data?: Array; }; /** * Encodes a string or array of bytes in Base64. */ export function base64_encode(input: string | Array): string; /** * Compiles a getter function from a getter expression. */ export function compileGetter(expr: string | Array): Function; /** * Compiles a setter function from a setter expression. */ export function compileSetter(expr: string | Array): Function; /** * The CustomStore enables you to implement custom data access logic for consuming data from any source. */ export class CustomStore extends Store { constructor(options?: CustomStoreOptions); /** * Gets a data item with a specific key. */ byKey( key: TKey, extraOptions?: LoadOptions ): DevExpress.core.utils.DxPromise; /** * Deletes data from the cache. Takes effect only if the cacheRawData property is true. */ clearRawDataCache(): void; /** * Starts loading data. */ load(): DevExpress.core.utils.DxExtendedPromise>; /** * Starts loading data. */ load( options: LoadOptions ): DevExpress.core.utils.DxExtendedPromise>; } /** * */ export type CustomStoreOptions = StoreOptions< TItem, TKey > & { /** * Specifies a custom implementation of the byKey(key) method. */ byKey?: ( key: TKey, extraOptions?: LoadOptions ) => PromiseLike; /** * 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: TItem) => PromiseLike; /** * Specifies a custom implementation of the load(options) method. */ load: ( options: LoadOptions ) => LoadFunctionResult>; /** * Specifies how data returned by the load function is treated. */ loadMode?: 'processed' | 'raw'; /** * A function that is executed after data is loaded to the store. */ onLoaded?: ( result: LoadResult, loadOptions: LoadOptions ) => void; /** * Specifies a custom implementation of the remove(key) method. */ remove?: (key: TKey) => PromiseLike; /** * Specifies a custom implementation of the totalCount(options) method. */ totalCount?: (loadOptions: { filter?: FilterDescriptor | Array; group?: GroupDescriptor | Array>; }) => PromiseLike; /** * Specifies a custom implementation of the update(key, values) method. */ update?: (key: TKey, values: TItem) => PromiseLike; /** * 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 | undefined; }; /** * The DataSource is an object that provides an API for processing data from an underlying store. */ export class DataSource { constructor(data: Array); constructor( options: | CustomStoreOptions | DataSourceOptions ); constructor(store: DevExpress.data.utils.Store); constructor(url: string); /** * Cancels the load operation with a specific identifier. */ cancel(operationId: number): boolean; /** * Disposes of all the resources allocated to the DataSource instance. */ dispose(): void; /** * Gets the filter property's value. */ filter(): FilterDescriptor | Array; /** * Sets the filter property's value. */ filter(filterExpr: FilterDescriptor | Array): void; /** * Gets the group property's value. */ group(): GroupDescriptor | Array>; /** * Sets the group property's value. */ group( groupExpr: GroupDescriptor | Array> ): 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 data is being loaded in the DataSource. */ isLoading(): boolean; /** * Gets an array of data items on the current page. */ items(): Array; /** * Gets the value of the underlying store's key property. */ key(): string | Array; /** * Starts loading data. */ load(): DevExpress.core.utils.DxExtendedPromise; /** * Gets an object with current data processing settings. */ loadOptions(): LoadOptions; /** * Detaches all event handlers from a single event. */ off(eventName: DataSourceEventName): this; /** * Detaches a particular event handler from a single event. */ off(eventName: DataSourceEventName, eventHandler: Function): this; /** * Subscribes to an event. */ on(eventName: DataSourceEventName, eventHandler: Function): this; /** * Subscribes to events. */ on(events: { [key in DataSourceEventName]?: Function }): this; /** * Gets the current page index. */ pageIndex(): number; /** * Sets the index of the page that should be loaded on the next load() method call. */ pageIndex(newIndex: number): void; /** * Gets the page size. */ pageSize(): number; /** * Sets the page size. */ pageSize(value: number): void; /** * Gets the paginate property's value. */ paginate(): boolean; /** * Sets the paginate property's value. */ paginate(value: boolean): void; /** * Clears currently loaded DataSource items and calls the load() method. */ reload(): DevExpress.core.utils.DxExtendedPromise; /** * Gets the requireTotalCount property's value. */ requireTotalCount(): boolean; /** * Sets the requireTotalCount property's value. */ requireTotalCount(value: boolean): void; /** * Gets the searchExpr property's value. */ searchExpr(): string & Function & Array; /** * Sets the searchExpr property's value. */ searchExpr(expr: string | Function | Array): void; /** * Gets the searchOperation property's value. */ searchOperation(): string; /** * Sets the searchOperation property's value. */ searchOperation(op: string): void; /** * Gets the searchValue property's value. */ searchValue(): any; /** * Sets the searchValue property's value. */ searchValue(value: any): void; /** * Gets the select property's value. */ select(): SelectDescriptor; /** * Sets the select property's value. */ select(expr: SelectDescriptor): void; /** * Gets the sort property's value. */ sort(): SortDescriptor | Array>; /** * Sets the sort property's value. */ sort(sortExpr: SortDescriptor | Array>): void; /** * Gets the instance of the store underlying the DataSource. */ store(): DevExpress.data.utils.Store; /** * Gets the number of data items in the store after the last load() operation without paging. Takes effect only if requireTotalCount is true */ totalCount(): number; } /** * */ export type DataSourceOptions< TStoreItem = any, TMappedItem = TStoreItem, TItem = TMappedItem, TKey = any > = { /** * Custom parameters that should be passed to an OData service with the load query. Available only for the ODataStore. */ customQueryParams?: any; /** * Specifies the navigation properties to be loaded with the OData entity. Available only for the ODataStore. */ expand?: Array | string; /** * Specifies data filtering conditions. */ filter?: FilterDescriptor | Array; /** * Specifies data grouping properties. */ group?: GroupDescriptor | Array>; /** * Specifies parameters for language-specific sorting and filtering. */ langParams?: LangParams; /** * Specifies an item mapping function. */ map?: (dataItem: TStoreItem) => TMappedItem; /** * A function that is executed after data is loaded. */ onChanged?: (e: { readonly changes?: Array }) => void; /** * A function that is executed when data loading fails. */ onLoadError?: (error: { readonly message?: string }) => void; /** * A function that is executed when the data loading status changes. */ onLoadingChanged?: (isLoading: boolean) => void; /** * Specifies the maximum number of data items per page. Applies only if paginate is true. */ pageSize?: number; /** * Specifies whether the DataSource loads data items by pages or all at once. Defaults to false if group is set; otherwise, true. */ paginate?: boolean | undefined; /** * Specifies a post processing function. */ postProcess?: (data: Array) => Array; /** * Specifies the period (in milliseconds) when changes are aggregated before pushing them to the DataSource. */ pushAggregationTimeout?: number | undefined; /** * Specifies whether the DataSource requests the total count of data items in the storage. */ requireTotalCount?: boolean; /** * Specifies whether to reapply sorting, filtering, grouping, and other data processing operations after receiving a push. */ reshapeOnPush?: boolean; /** * Specifies the fields to search. */ searchExpr?: string | Function | Array; /** * Specifies the comparison operation used in searching. */ searchOperation?: SearchOperation; /** * Specifies the value to which the search expression is compared. */ searchValue?: any; /** * Specifies the fields to select from data objects. */ select?: SelectDescriptor; /** * Specifies data sorting properties. */ sort?: SortDescriptor | Array>; /** * Configures the store underlying the DataSource. */ store?: | Array | DevExpress.data.utils.Store | DevExpress.data.utils.StoreOptions; }; /** * The EdmLiteral is an object for working with primitive data types from the OData's Abstract Type System that are not supported in JavaScript. */ export class EdmLiteral { constructor(value: string); /** * Gets the EdmLiteral's value converted to a string. */ valueOf(): 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; } /** * Specifies the function that is executed when a data layer object throws an error. * @deprecated Use setErrorHandler instead. */ export function errorHandler(e: Error): void; /** * */ export type FilterDescriptor = DevExpress.data.FilterDescriptor; /** * */ export type GroupDescriptor = DevExpress.data.GroupDescriptor; export type GroupingInterval = DevExpress.data.GroupingInterval; /** * An additional type for LoadResult. */ export type GroupItem = { /** * A key to group items by. */ key: any | string | number; /** * Contains an array of items or GroupItems, or nothing. */ items: Array | Array> | null; /** * A total number of items. */ count?: number; /** * A summary array that contains the resulting values in the same order as the summary definitions. */ summary?: Array; }; /** * A type guard function that checks whether LoadResult is an array of GroupItems. */ export function isGroupItemsArray( res: LoadResult ): res is Array>; /** * A type guard function that checks whether LoadResult is an array of items. */ export function isItemsArray( res: LoadResult ): res is Array; /** * A type guard function that checks whether LoadResult is a LoadResultObject. */ export function isLoadResultObject( res: LoadResult ): res is LoadResultObject; /** * Contains built-in OData type converters (for String, Int32, Int64, Boolean, Single, Decimal, and Guid) and allows you to register a custom type converter. */ export var keyConverters: any; /** * Specifies parameters for language-specific sorting and filtering. */ export type LangParams = { /** * Specifies the locale whose features affect sorting and filtering. */ locale: string; /** * Specifies Intl.Collator options. */ collatorOptions?: Intl.CollatorOptions; }; /** * This section describes the loadOptions object's fields. */ export type LoadOptions = DevExpress.data.LoadOptions; /** * Specifies returned data of the `load()` method in CustomStore. */ export type LoadResult = | Object | LoadResultArray | LoadResultObject; /** * An additional type for LoadResult. */ export type LoadResultObject = { /** * Contains an array of items or GroupItems. */ data: Array | Array>; /** * A total number of items. */ totalCount?: number; /** * A summary array that contains the resulting values in the same order as the summary definitions. */ summary?: Array; /** * A number of groups. */ groupCount?: number; }; /** * The LocalStore is a store that provides an interface for loading and editing data from HTML Web Storage (also known as window.localStorage) and handling related events. */ export class LocalStore extends ArrayStore< TItem, TKey > { constructor(options?: LocalStoreOptions); /** * Removes data from the local storage. */ clear(): void; } /** * */ export type LocalStoreOptions = ArrayStoreOptions< TItem, TKey > & { /** * Specifies a delay in milliseconds between when data changes and the moment these changes are saved in the local storage. Applies only if immediate is false. */ flushInterval?: number; /** * Specifies whether the LocalStore saves changes in the local storage immediately. */ immediate?: boolean; /** * Specifies the name under which data should be saved in the local storage. The `dx-data-localStore-` prefix will be added to the name. */ name?: string; }; /** * The ODataContext is an object that provides access to an entire OData service. */ export class ODataContext { constructor(options?: ODataContextOptions); /** * Invokes an OData operation that returns a value. */ get( operationName: string, params: any ): DevExpress.core.utils.DxPromise; /** * Invokes an OData operation that returns nothing. */ invoke( operationName: string, params: any, httpMethod: HttpMethod ): DevExpress.core.utils.DxPromise; /** * Gets a link to an entity with a specific key. */ objectLink(entityAlias: string, key: any | string | number): any; } /** * */ export type ODataContextOptions = { /** * Specifies a function that customizes the request before it is sent to the server. */ beforeSend?: (options: { url: string; async: boolean; method: string; timeout: number; params: any; payload: any; headers: any; }) => void; /** * Specifies whether stores in the ODataContext serialize/parse date-time values. */ deserializeDates?: boolean; /** * Specifies entity collections to be accessed. */ entities?: any; /** * Specifies a function that is executed when the ODataContext throws an error. */ errorHandler?: (e: { httpStatus: number; errorDetails: any; requestOptions: ODataRequestOptions; }) => void; /** * Specifies whether to convert string values to lowercase in filter and search requests. Applies to the following operations: 'startswith', 'endswith', 'contains', and 'notcontains'. */ filterToLower?: boolean; /** * Specifies whether data should be sent using JSONP. */ jsonp?: boolean; /** * Specifies the URL of an OData service. */ url?: string; /** * Specifies the OData version. */ version?: number; /** * Specifies whether to send cookies, authorization headers, and client certificates in a cross-origin request. */ withCredentials?: boolean; }; /** * The ODataStore is a store that provides an interface for loading and editing data from an individual OData entity collection and handling related events. */ export class ODataStore extends AbstractStore< TItem, TKey > { constructor(options?: ODataStoreOptions); /** * Gets an entity with a specific key. */ byKey( key: TKey, extraOptions?: { expand?: string | Array; select?: string | Array; } ): DevExpress.core.utils.DxPromise; /** * Creates a Query for the OData endpoint. */ createQuery(loadOptions?: { expand?: string | Array; requireTotalCount?: boolean; customQueryParams?: any; }): Query; } /** * */ export type ODataStoreOptions = AbstractStoreOptions< TItem, TKey > & { /** * Specifies a function that customizes the request before it is sent to the server. */ beforeSend?: (options: { url: string; async: boolean; method: string; timeout: number; params: any; payload: any; headers: any; }) => void; /** * Specifies whether the store serializes/parses date-time values. */ deserializeDates?: boolean; /** * Specifies a function that is executed when the ODataStore throws an error. */ errorHandler?: (e: { httpStatus: number; errorDetails: any; requestOptions: ODataRequestOptions; }) => void; /** * Specifies the data field types. Accepts the following types: 'String', 'Int32', 'Int64', 'Boolean', 'Single', 'Decimal' and 'Guid'. */ fieldTypes?: any; /** * Specifies whether to convert string values to lowercase in filter and search requests. Applies to the following operations: 'startswith', 'endswith', 'contains', and 'notcontains'. */ filterToLower?: boolean; /** * Specifies whether data should be sent using JSONP. */ jsonp?: boolean; /** * Specifies the type of the key property or properties. */ keyType?: | 'String' | 'Int32' | 'Int64' | 'Guid' | 'Boolean' | 'Single' | 'Decimal' | any; /** * Specifies the URL of an OData entity collection. */ url?: string; /** * Specifies the OData version. */ version?: number; /** * Specifies whether to send cookies, authorization headers, and client certificates in a cross-origin request. */ withCredentials?: boolean; }; /** * Creates a Query instance. */ export function query(array: Array, queryOptions?: any): Query; /** * Creates a Query instance that accesses a remote data service using its URL. */ export function query(url: string, queryOptions: any): Query; /** * The Query is an object that provides a chainable interface for making data queries. */ export type Query = { /** * Calculates a custom summary for all data items. */ aggregate( seed: any, step: Function, finalize: Function ): DevExpress.core.utils.DxPromise; /** * Calculates a custom summary for all data items. */ aggregate(step: Function): DevExpress.core.utils.DxPromise; /** * Calculates the average of all values. Applies only to numeric arrays. */ avg(): DevExpress.core.utils.DxPromise; /** * Calculates the average of all values found using a getter. */ avg(getter: any): DevExpress.core.utils.DxPromise; /** * Calculates the number of data items. */ count(): DevExpress.core.utils.DxPromise; /** * Executes the Query. This is an asynchronous alternative to the toArray() method. */ enumerate(): DevExpress.core.utils.DxPromise; /** * Filters data items using a filter expression. */ filter(criteria: Array): Query; /** * Filters data items using a custom function. */ filter(predicate: Function): Query; /** * Groups data items by the specified getter. */ groupBy(getter: any): Query; /** * Calculates the maximum value. Applies only to numeric arrays. */ max(): DevExpress.core.utils.DxPromise; /** * Calculates the maximum of all values found using a getter. */ max(getter: any): DevExpress.core.utils.DxPromise; /** * Calculates the minimum value. Applies only to numeric arrays. */ min(): DevExpress.core.utils.DxPromise; /** * Calculates the minumum of all values found using a getter. */ min(getter: any): DevExpress.core.utils.DxPromise; /** * Selects individual fields from data objects. */ select(...getters: any[]): Query; /** * Gets a specified number of data items starting from a given index. */ slice(skip: number, take?: number): Query; /** * Sorts data items by the specified getter in ascending order. */ sortBy(getter: any): Query; /** * Sorts data items by the specified getter in the specified sorting order. */ sortBy(getter: any, desc: boolean): Query; /** * Calculates the sum of all values. */ sum(): DevExpress.core.utils.DxPromise; /** * Calculates the sum of all values found using a getter. */ sum(getter: any): DevExpress.core.utils.DxPromise; /** * Sorts data items by one more getter in ascending order. */ thenBy(getter: any): Query; /** * Sorts data items by one more getter in the specified sorting order. */ thenBy(getter: any, desc: boolean): Query; /** * Gets data items associated with the Query. This is a synchronous alternative to the enumerate() method. */ toArray(): Array; }; /** * Specifies returned data of the `load()` method in CustomStore. * @deprecated Use LoadResult instead. */ export type ResolvedData = LoadResult; export type SearchOperation = DevExpress.data.SearchOperation; /** * */ export type SelectDescriptor = DevExpress.data.SelectDescriptor; /** * A method that specifies a function to be executed when a Data Layer component throws an error. */ export function setErrorHandler(handler: (e: Error) => void): void; /** * */ export type SortDescriptor = DevExpress.data.SortDescriptor; /** * The base class for all Stores. * @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 Store { constructor(options?: StoreOptions); /** * Adds a data item to the store. */ insert(values: TItem): DevExpress.core.utils.DxExtendedPromise; /** * Gets the key property (or properties) as specified in the key property. */ key(): string | Array; /** * Gets a data item's key value. */ keyOf(obj: TItem): TKey; /** * Detaches all event handlers from a single event. */ off(eventName: DevExpress.data.StoreEventName): this; /** * Detaches a particular event handler from a single event. */ off( eventName: DevExpress.data.StoreEventName, eventHandler: Function ): this; /** * Subscribes to an event. */ on(eventName: DevExpress.data.StoreEventName, eventHandler: Function): this; /** * Subscribes to events. */ on(events: { [key in DevExpress.data.StoreEventName]?: Function }): this; /** * Pushes data changes to the store and notifies the DataSource. */ push( changes: Array<{ type: 'insert' | 'update' | 'remove'; data?: DevExpress.core.DeepPartial; key?: TKey; index?: number; }> ): void; /** * Removes a data item with a specific key from the store. */ remove(key: TKey): DevExpress.core.utils.DxPromise; /** * Gets the total count of items the load() function returns. */ totalCount(obj: { filter?: FilterDescriptor | Array; group?: GroupDescriptor | Array>; }): DevExpress.core.utils.DxPromise; /** * Updates a data item with a specific key. */ update( key: TKey, values: DevExpress.core.DeepPartial ): DevExpress.core.utils.DxExtendedPromise; } /** * * @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 StoreOptions = { /** * Specifies the function that is executed when the store throws an error. */ errorHandler?: Function; /** * Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. */ key?: string | Array; /** * A function that is executed after a data item is added to the store. */ onInserted?: (values: TItem, key: TKey) => void; /** * A function that is executed before a data item is added to the store. */ onInserting?: (values: TItem) => void; /** * A function that is executed before data is loaded to the store. */ onLoading?: (loadOptions: LoadOptions) => void; /** * A function that is executed after a data item is added, updated, or removed from the store. */ onModified?: Function; /** * A function that is executed before a data item is added, updated, or removed from the store. */ onModifying?: Function; /** * The function executed before changes are pushed to the store. */ onPush?: (changes: Array) => void; /** * A function that is executed after a data item is removed from the store. */ onRemoved?: (key: TKey) => void; /** * A function that is executed before a data item is removed from the store. */ onRemoving?: (key: TKey) => void; /** * A function that is executed after a data item is updated in the store. */ onUpdated?: (key: TKey, values: TItem) => void; /** * A function that is executed before a data item is updated in the store. */ onUpdating?: (key: TKey, values: TItem) => void; }; /** * A total summary expression for `loadOptions`. */ export type SummaryDescriptor = DevExpress.data.SummaryDescriptor; } declare module DevExpress.common.Export.excel { export type DataGridCell = DevExpress.excelExporter.ExcelDataGridCell; /** * Properties that can be passed to the exportDataGrid(options) method from the excelExporter module. */ export type DataGridExportOptions = DevExpress.excelExporter.ExcelExportBaseOptions & { /** * A DataGrid instance. This setting is required. */ component?: DevExpress.ui.dxDataGrid | undefined; /** * Specifies whether to export only selected rows. */ selectedRowsOnly?: boolean; /** * Specifies whether to enable Excel filtering in the document. */ autoFilterEnabled?: boolean; /** * Customizes an Excel cell after creation. */ customizeCell?: (options: { gridCell?: DataGridCell; excelCell?: any; }) => void; }; /** * Exports grid data to Excel. */ export function exportDataGrid( options: DataGridExportOptions ): DevExpress.core.utils.DxPromise; /** * Exports pivot grid data to Excel. */ export function exportPivotGrid( options: PivotGridExportOptions ): DevExpress.core.utils.DxPromise; export type PivotGridCell = DevExpress.excelExporter.ExcelPivotGridCell; /** * Properties that can be passed to the exportPivotGrid(options) method from the excelExporter module. */ export type PivotGridExportOptions = DevExpress.excelExporter.ExcelExportBaseOptions & { /** * A PivotGrid instance. This setting is required. */ component?: DevExpress.ui.dxPivotGrid | undefined; /** * Specifies whether to merge neighbouring cells in the row field if they have the same values. */ mergeRowFieldValues?: boolean; /** * Specifies whether to merge neighbouring cells in the column field if they have the same values. */ mergeColumnFieldValues?: boolean; /** * Specifies whether to export headers of the filter fields on the field panel. */ exportFilterFieldHeaders?: boolean; /** * Specifies whether to export headers of the data fields on the field panel. */ exportDataFieldHeaders?: boolean; /** * Specifies whether to export headers of the column fields on the field panel. */ exportColumnFieldHeaders?: boolean; /** * Specifies whether to export headers of the row fields on the field panel. */ exportRowFieldHeaders?: boolean; /** * Customizes an Excel cell after creation. */ customizeCell?: (options: { pivotCell?: PivotGridCell; excelCell?: any; }) => void; }; } declare module DevExpress.common.Export.pdf { /** * An object that configures export to PDF settings in a DataGrid cell. */ export type Cell = { /** * Specifies the background color of the cell. */ backgroundColor?: string; /** * Specifies the color of the cell's outer borders. */ borderColor?: string; /** * Specifies the width of the cell's borders. */ borderWidth?: number; /** * Specifies whether to show cell's left border. */ drawLeftBorder?: boolean; /** * Specifies whether to show cell's top border. */ drawTopBorder?: boolean; /** * Specifies whether to show cell's right border. */ drawRightBorder?: boolean; /** * Specifies whether to show cell's bottom border. */ drawBottomBorder?: boolean; /** * An object that contains information about the font's size, name, and style. */ font?: { /** * Specifies the font size. */ size?: number; /** * Specifies the font name. */ name?: string; /** * Specifies the font style. */ style?: 'normal' | 'bold' | 'italic'; }; /** * Specifies the horizontal alignment for the text inside the exported cell. */ horizontalAlign?: 'left' | 'center' | 'right'; /** * Specifies the top, bottom, left, and right paddings of the DataGrid cell. */ padding?: { /** * Specifies the top padding of the DataGrid cell. */ top?: number; /** * Specifies the left padding of the DataGrid cell. */ left?: number; /** * Specifies the right padding of the DataGrid cell. */ right?: number; /** * Specifies the bottom padding of the DataGrid cell. */ bottom?: number; }; /** * The cell's text. */ text?: string; /** * Specifies the text color for the cell. */ textColor?: string; /** * Specifies the vertical alignment for the text inside the exported cell. */ verticalAlign?: 'top' | 'middle' | 'bottom'; /** * Specifies whether to enable word wrapping in the resulting PDF file. */ wordWrapEnabled?: boolean; }; export type DataGridCell = DevExpress.pdfExporter.PdfDataGridCell; /** * Properties that can be passed as a parameter to the exportDataGrid(options) method from the pdfExporter module. */ export type DataGridExportOptions = { /** * A jsPDF instance. This setting is required. */ jsPDFDocument?: object | undefined; /** * A DataGrid instance. This setting is required. */ component?: DevExpress.ui.dxDataGrid | undefined; /** * Specifies the top left position of the DataGrid in the exported PDF document. Contains x and y properties. You can locate this position only below the page margins. */ topLeft?: { /** * Specifies the horizontal position of the exported DataGrid. */ x?: number; /** * Specifies the vertical position of the exported DataGrid. */ y?: number; }; /** * Specifies a custom width for the exported DataGrid columns. */ columnWidths?: Array | undefined; /** * Specifies the width of the indent of data rows relative to their group header row. */ indent?: number; /** * Specifies the margin for the top, bottom, left, and right sides of the exported Grid. */ margin?: { /** * Specifies the margin at the top of the page. */ top?: number; /** * Specifies the margin at the left side of the page. */ left?: number; /** * Specifies the margin at the right side of the page. */ right?: number; /** * Specifies the margin at the bottom of the page. */ bottom?: number; }; /** * Specifies whether to repeat the DataGrid column headers on each page. */ repeatHeaders?: boolean; /** * Specifies whether or not to export only selected rows. */ selectedRowsOnly?: boolean; /** * A function that allows you to draw cell content of the exported DataGrid. This function is executed before the cell is exported. */ customDrawCell?: (options: { gridCell?: DataGridCell; pdfCell?: Cell; doc?: any; rect?: { x: number; y: number; h: number; w: number }; cancel?: boolean; }) => void; /** * Customizes a cell in PDF after creation. */ customizeCell?: (options: { gridCell?: DataGridCell; pdfCell?: Cell; }) => void; /** * A function that allows you to customize the height of the exported row. This function is executed before the row export. */ onRowExporting?: (options: { rowCells?: Array; rowHeight?: number; }) => void; /** * Configures the load panel. */ loadPanel?: ExportLoadPanel; }; /** * Exports grid data to a PDF file. */ export function exportDataGrid( options: DataGridExportOptions ): DevExpress.core.utils.DxPromise; /** * Exports Gantt data to a PDF file. */ export function exportGantt( options: GanttExportOptions ): DevExpress.core.utils.DxPromise; /** * Configures a custom font used for the Gantt data export. */ export type GanttExportFont = { /** * A custom font object. */ fontObject: object | undefined; /** * The font name. */ name: string | undefined; /** * The font style. */ style?: string; /** * The font weight. */ weight?: string | number | undefined; }; /** * Properties that you can pass as a parameter to the exportGantt(options) method from the pdfExporter module. */ export type GanttExportOptions = { /** * A function that creates a PDF document. */ createDocumentMethod?: (options: any) => object; /** * A jsPDF instance. This setting is required. */ jsPDFDocument?: object | undefined; /** * A Gantt instance. This setting is required. */ component?: DevExpress.ui.dxGantt | undefined; /** * Specifies the document size. */ format?: string | object | undefined; /** * Specifies whether to use horizontal orientation for the document. */ landscape?: boolean; /** * Specifies the file name. */ fileName?: string | undefined; /** * Specifies the outer indents of the exported area. */ margins?: object | undefined; /** * Specifies which part of the component to export (chart area, tree list area, or the entire component). */ exportMode?: DevExpress.ui.dxGantt.GanttPdfExportMode; /** * Specifies the date range for which to export tasks. */ dateRange?: DevExpress.ui.dxGantt.GanttPdfExportDateRange | object; /** * Specifies the font. */ font?: GanttExportFont; }; } declare module DevExpress.common.grids { /** * * @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 AdaptiveDetailRowPreparingInfo = { /** * */ readonly formOptions: any; }; export type ApplyChangesMode = 'instantly' | 'onDemand'; export type ApplyFilterMode = 'auto' | 'onClick'; /** * * @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 ColumnBase { /** * Aligns the content of the column. */ alignment?: HorizontalAlignment | undefined; /** * Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating property. */ allowEditing?: boolean; /** * Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true. */ allowFiltering?: boolean; /** * Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true. */ allowFixing?: boolean; /** * Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering property. */ allowHeaderFiltering?: boolean; /** * Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true. */ allowHiding?: boolean; /** * Specifies whether users can reorder this column. Overrides the allowColumnReordering property value. */ allowReordering?: boolean; /** * Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true. */ allowResizing?: boolean; /** * Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering property by default. */ allowSearch?: boolean; /** * Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from 'none'. */ allowSorting?: boolean; /** * Calculates custom cell values. Use this function to create an unbound data column. */ calculateCellValue?: (this: ColumnBase, rowData: TRowData) => any; defaultCalculateCellValue?: this['calculateCellValue']; /** * Calculates custom display values for column cells. Requires specifying the dataField or calculateCellValue property. Used in lookup optimization. */ calculateDisplayValue?: | string | ((this: ColumnBase, rowData: TRowData) => any); /** * Specifies the column's custom rules to filter data. */ calculateFilterExpression?: ( this: ColumnBase, filterValue: any, selectedFilterOperation: string | null, target: string ) => string | Array | Function; defaultCalculateFilterExpression?: this['calculateFilterExpression']; /** * Calculates custom values used to sort this column. */ calculateSortValue?: | string | ((this: ColumnBase, rowData: TRowData) => any); /** * Specifies a caption for the column. */ caption?: string | undefined; /** * Specifies a CSS class to be applied to the column. */ cssClass?: string | undefined; /** * Customizes the text displayed in column cells. */ customizeText?: ( this: ColumnBase, cellInfo: ColumnCustomizeTextArg ) => string; /** * Binds the column to a field of the dataSource. */ dataField?: string | undefined; /** * Casts column values to a specific data type. */ dataType?: DataType | undefined; /** * Configures the default UI component used for editing and filtering in the filter row. */ editorOptions?: any; /** * Specifies whether HTML tags are displayed as plain text or applied to the values of the column. */ encodeHtml?: boolean; /** * In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways property is false. */ falseText?: string; /** * Specifies available filter operations. Applies if allowFiltering is true and the filterRow and/or filterPanel are visible. */ filterOperations?: Array; /** * Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are true. */ filterType?: FilterType; /** * Specifies the value to display in the filter row. */ filterValue?: any | undefined; /** * Sets the values in the header filter. */ filterValues?: Array; /** * Fixes the column. */ fixed?: boolean; /** * Specifies the column position. Applies only if columns[].fixed is true. */ fixedPosition?: FixedPosition | undefined; /** * Configures the form item that the column produces in the editing state. Applies only if editing.mode is 'form' or 'popup'. */ formItem?: DevExpress.ui.dxForm.SimpleItem; /** * Formats a value before it is displayed in a column cell. */ format?: DevExpress.common.core.localization.Format; /** * Specifies data settings for the header filter. */ headerFilter?: ColumnHeaderFilter | undefined; /** * Specifies the order in which columns are hidden when the UI component adapts to the screen or container size. Ignored if allowColumnResizing is `true` and columnResizingMode is 'widget'. */ hidingPriority?: number | undefined; /** * Specifies whether the column organizes other columns into bands. */ isBand?: boolean | undefined; /** * Specifies properties of a lookup column. */ lookup?: ColumnLookup | undefined; /** * Specifies the minimum width of the column. */ minWidth?: number | undefined; /** * Specifies the column's unique identifier. If not set in code, this value is inherited from the dataField. */ name?: string | undefined; /** * Specifies the band column that owns the current column. Accepts the index of the band column in the columns array. */ ownerBand?: number | undefined; /** * Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width property specified. */ renderAsync?: boolean; /** * Specifies a filter operation that applies when users use the filter row to filter the column. */ selectedFilterOperation?: SelectedFilterOperation | undefined; /** * Specifies a function to be invoked after the user has edited a cell value, but before it is saved in the data source. */ setCellValue?: ( this: ColumnBase, newData: DevExpress.core.DeepPartial, value: any, currentRowData: TRowData ) => void | PromiseLike; defaultSetCellValue?: this['setCellValue']; /** * Specifies whether the column displays its values in editors. */ showEditorAlways?: boolean; /** * Specifies whether the column chooser can contain the column header. */ showInColumnChooser?: boolean; /** * Specifies the index according to which columns participate in sorting. */ sortIndex?: number | undefined; /** * Specifies the sort order of column values. */ sortOrder?: SortOrder | undefined; /** * Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client. */ sortingMethod?: | ((this: ColumnBase, value1: any, value2: any) => number) | undefined; /** * In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways property is false. */ trueText?: string; /** * Specifies validation rules to be checked when cell values are updated. */ validationRules?: Array; /** * Specifies whether the column is visible, that is, occupies space in the table. */ visible?: boolean; /** * Specifies the position of the column regarding other columns in the resulting UI component. */ visibleIndex?: number | undefined; /** * Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth. */ width?: number | string | undefined; } /** * Allows you to customize buttons in the edit column or create a custom command column. Applies only if the column's type is 'buttons'. * @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 ColumnButtonBase { /** * Specifies a CSS class to be applied to the button. */ cssClass?: string; /** * Specifies the text for the hint that appears when the button is hovered over or long-pressed. */ hint?: string; /** * Specifies the button's icon. */ icon?: string; /** * Specifies the button's text. Applies only if the button's icon is not specified. */ text?: string; } /** * Configures the column chooser. */ export type ColumnChooser = { /** * Specifies whether searching is enabled in the column chooser. * @deprecated Use `search.enabled` instead. */ allowSearch?: boolean; /** * Specifies a container in which the column chooser should be rendered. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies text displayed by the column chooser when it is empty. */ emptyPanelText?: string; /** * Specifies whether a user can open the column chooser. */ enabled?: boolean; /** * Specifies the height of the column chooser. */ height?: number | string; /** * Specifies how a user manages columns using the column chooser. */ mode?: ColumnChooserMode; /** * Configures the column chooser's position. */ position?: DevExpress.common.core.animation.PositionConfig | undefined; /** * Configures the column chooser's search functionality. */ search?: ColumnChooserSearchConfig; /** * Specifies a delay in milliseconds between when a user finishes typing in the column chooser's search panel, and when the search is executed. * @deprecated Use `search.timeout` instead. */ searchTimeout?: number; /** * Configures column selection functionality within the column chooser. */ selection?: ColumnChooserSelectionConfig; /** * Specifies the title of the column chooser. */ title?: string; /** * Specifies the width of the column chooser. */ width?: number | string; /** * Specifies the sort order of column headers. */ sortOrder?: SortOrder | undefined; }; export type ColumnChooserMode = 'dragAndDrop' | 'select'; /** * Configures the column chooser's search functionality. */ export type ColumnChooserSearchConfig = { /** * Configures the search box. */ editorOptions?: any; /** * Specifies whether search is enabled in the column chooser. */ enabled?: boolean; /** * Specifies a timeout, in milliseconds, during which a user may continue to modify the search value without starting the search operation. */ timeout?: number; }; /** * Configures column selection functionality within the column chooser. */ export type ColumnChooserSelectionConfig = { /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies whether selection is recursive. */ recursive?: boolean; /** * Specifies whether an item becomes selected if a user clicks the item's label. */ selectByClick?: boolean; }; export type ColumnCustomizeTextArg = { value?: any; valueText?: string; target?: string; groupInterval?: string | number; }; /** * Configures column fixing. */ export type ColumnFixing = { /** * Enables column fixing. */ enabled?: boolean; /** * Contains properties that specify texts for column fixing commands in the context menu of a column header. */ texts?: ColumnFixingTexts; /** * Contains properties that specify icons for column fixing commands in the context menu of a column header. */ icons?: ColumnFixingIcons; }; /** * Configures column fixing icons. */ export type ColumnFixingIcons = { /** * Specifies an icon for the context menu item that fixes a column. */ fix?: string; /** * Specifies an icon for the context menu subitem that fixes a column to the left edge of the UI component. */ leftPosition?: string; /** * Specifies an icon for the context menu subitem that fixes a column to the right edge of the UI component. */ rightPosition?: string; /** * Specifies an icon for the context menu item that unfixes a column. */ unfix?: string; /** * Specifies an icon for the context menu subitem that enables sticky column behavior. */ stickyPosition?: string; }; /** * Contains properties that specify texts for column fixing commands in the context menu of a column header. */ export type ColumnFixingTexts = { /** * Specifies text for the context menu item that fixes a column. */ fix?: string; /** * Specifies text for the context menu subitem that fixes a column to the left edge of the UI component. */ leftPosition?: string; /** * Specifies text for the context menu subitem that fixes a column to the right edge of the UI component. */ rightPosition?: string; /** * Specifies text for the context menu item that unfixes a column. */ unfix?: string; /** * Specifies text for the context menu subitem that enables sticky column behavior. */ stickyPosition?: string; }; /** * Specifies data settings for the header filter. */ export type ColumnHeaderFilter = { /** * Specifies whether searching is enabled in the header filter. * @deprecated Use `search.enabled` instead. */ allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies the header filter's data source. */ dataSource?: | DevExpress.ui.dxFilterBuilder.FilterLookupDataSource | ((options: { component?: any; dataSource?: DevExpress.common.data.DataSourceOptions | null; }) => void) | undefined; /** * Specifies how the header filter combines values into groups. */ groupInterval?: HeaderFilterGroupInterval | number | undefined; /** * Specifies the height of the popup menu containing filtering values. */ height?: number | string | undefined; /** * Configures the header filter's search functionality. */ search?: ColumnHeaderFilterSearchConfig; /** * Specifies a comparison operation used to search header filter values. * @deprecated Use `search.mode` instead. */ searchMode?: SearchMode; /** * Specifies the width of the popup menu containing filtering values. */ width?: number | string | undefined; }; /** * Configures the header filter's search. */ export type ColumnHeaderFilterSearchConfig = HeaderFilterSearchConfig & { /** * Specifies a data object's field name or an expression whose value is compared to the search string. */ searchExpr?: string | Function | Array | undefined; }; export type ColumnLookup = { /** * Specifies whether to display the Clear button in lookup column cells while they are being edited. */ allowClearing?: boolean; /** * Specifies the data source for the lookup column. */ dataSource?: | DevExpress.ui.dxFilterBuilder.FilterLookupDataSource | ((options: { data?: any; key?: any; }) => DevExpress.ui.dxFilterBuilder.FilterLookupDataSource) | null | undefined; /** * Specifies the data source field whose values must be displayed. */ displayExpr?: string | ((data: any) => string) | undefined; /** * Specifies the data field whose values should be replaced with values from the displayExpr field. */ valueExpr?: string | undefined; /** * */ calculateCellValue?: (rowData: any) => any; }; export type ColumnResizeMode = 'nextColumn' | 'widget'; /** * */ export type DataChange = { /** * The key of the row being created, updated, or removed. */ key: TKey; /** * Data change type. */ type: DataChangeType; /** * An object with updated row fields. */ data: DevExpress.core.DeepPartial; /** * A key that identifies a record after which a new record should be inserted. Applies only if the type is 'insert'. */ insertAfterKey?: TKey; /** * A key that identifies the record before which a new record should be inserted. Applies only if the type is 'insert'. */ insertBeforeKey?: TKey; }; /** * * @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 DataChangeInfo = { /** * */ readonly changes: Array>; }; export type DataChangeType = 'insert' | 'update' | 'remove'; /** * * @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 DataErrorOccurredInfo = { /** * */ readonly error?: Error; }; export type DataRenderMode = 'standard' | 'virtual'; /** * @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 DragDropInfo = { readonly dropInsideItem: 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 DragReorderInfo = { readonly dropInsideItem: boolean; promise?: PromiseLike; }; /** * @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 DragStartEventInfo { itemData?: TRowData; readonly itemElement: DevExpress.core.DxElement; readonly fromIndex: number; readonly fromData?: any; } /** * Overriden. * @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 EditingBase { /** * Specifies if confirmation is required when a user deletes a row. */ confirmDelete?: boolean; /** * An array of pending row changes. */ changes?: Array>; /** * The name of a column being edited. Applies only if editing.mode is 'cell' or 'batch'. */ editColumnName?: string; /** * The key(s) of a row being edited. */ editRowKey?: TKey; /** * Configures the form. Used only if editing.mode is 'form' or 'popup'. */ form?: DevExpress.ui.dxForm.Properties; /** * Specifies how a user edits data. */ mode?: GridsEditMode; /** * Configures the popup. Used only if editing.mode is 'popup'. */ popup?: DevExpress.ui.dxPopup.Properties; /** * Specifies operations that are performed after saving changes. */ refreshMode?: GridsEditRefreshMode; /** * Specifies whether to select text in a cell when a user starts editing. */ selectTextOnEditStart?: boolean; /** * Specifies whether a single or double click should switch a cell to the editing state. Applies if editing.mode is 'cell' or 'batch'. */ startEditAction?: StartEditAction; /** * Contains properties that specify texts for editing-related UI elements. */ texts?: EditingTextsBase; /** * Specifies whether the edit column uses icons instead of links. */ useIcons?: boolean; } /** * Contains properties that specify texts for editing-related UI elements. * @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 EditingTextsBase { /** * Specifies text for a hint that appears when a user pauses on the global 'Add' button. Applies only if editing.allowAdding is true. */ addRow?: string; /** * Specifies text for a hint that appears when a user pauses on the 'Discard' button. Applies only if editing.mode is 'batch'. */ cancelAllChanges?: string; /** * Specifies text for a button that cancels changes in a row. Applies only if editing.allowUpdating is true and editing.mode is 'row', 'popup' or 'form'. */ cancelRowChanges?: string; /** * Specifies a message that prompts a user to confirm deletion. */ confirmDeleteMessage?: string; /** * Specifies a title for the window that asks a user to confirm deletion. */ confirmDeleteTitle?: string; /** * Specifies text for buttons that delete rows. Applies only if allowDeleting is true. */ deleteRow?: string; /** * Specifies text for buttons that switch rows into the editing state. Applies only if allowUpdating is true. */ editRow?: string; /** * Specifies text for a hint that appears when a user pauses on the global 'Save' button. Applies only if editing.mode is 'batch'. */ saveAllChanges?: string; /** * Specifies text for a button that saves changes made in a row. Applies only if allowUpdating is true and editing.mode is 'row', 'popup' or 'form'. */ saveRowChanges?: string; /** * Specifies text for buttons that recover deleted rows. Applies only if allowDeleting is true and editing.mode is 'batch'. */ undeleteRow?: string; /** * Specifies text for a hint appearing when a user pauses on the button that cancels changes in a cell. Applies only if editing.mode is 'cell' and data validation is enabled. */ validationCancelChanges?: string; } export type EnterKeyAction = 'startEdit' | 'moveFocus'; export type EnterKeyDirection = 'none' | 'column' | 'row'; export type FilterOperation = | '=' | '<>' | '<' | '<=' | '>' | '>=' | 'contains' | 'endswith' | 'isblank' | 'isnotblank' | 'notcontains' | 'startswith' | 'between' | 'anyof' | 'noneof'; /** * Configures the filter 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 FilterPanel { /** * Customizes the filter expression's text representation. */ customizeText?: (e: FilterPanelCustomizeTextArg) => string; /** * Specifies whether the filter expression is applied. */ filterEnabled?: boolean; /** * Specifies texts for the filter panel's elements. */ texts?: FilterPanelTexts; /** * Specifies whether the filter panel is visible. */ visible?: 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 interface FilterPanelCustomizeTextArg { readonly component: TComponent; readonly filterValue: any; readonly text: string; } /** * Specifies texts for the filter panel's elements. */ export type FilterPanelTexts = { /** * The text of the 'Clear' link. */ clearFilter?: string; /** * The text of the 'Create Filter' link. */ createFilter?: string; /** * The hint of the checkbox that applies the filter. */ filterEnabledHint?: string; }; /** * Configures the filter row. */ export type FilterRow = { /** * Specifies when to apply a filter. */ applyFilter?: ApplyFilterMode; /** * Specifies text for a hint that appears when a user pauses on a button that applies the filter. */ applyFilterText?: string; /** * Specifies a placeholder for the editor that specifies the end of a range when a user selects the 'between' filter operation. */ betweenEndText?: string; /** * Specifies a placeholder for the editor that specifies the start of a range when a user selects the 'between' filter operation. */ betweenStartText?: string; /** * Specifies descriptions for filter operations on the filter list. */ operationDescriptions?: FilterRowOperationDescriptions; /** * Specifies text for the reset operation on the filter list. */ resetOperationText?: string; /** * Specifies text for the item that clears the applied filter. Used only when a cell of the filter row contains a select box. */ showAllText?: string; /** * Specifies whether icons that open the filter lists are visible. */ showOperationChooser?: boolean; /** * Specifies whether the filter row is visible. */ visible?: boolean; }; /** * Specifies descriptions for filter operations on the filter list. */ export type FilterRowOperationDescriptions = { /** * A description for the 'between' operation. */ between?: string; /** * A description for the 'contains' operation. */ contains?: string; /** * A description for the 'endswith' operation. */ endsWith?: string; /** * A description for the '=' operation. */ equal?: string; /** * A description for the '>' operation. */ greaterThan?: string; /** * A description for the '>=' operation. */ greaterThanOrEqual?: string; /** * A description for the '<' operation. */ lessThan?: string; /** * A description for the '<=' operation. */ lessThanOrEqual?: string; /** * A description for the 'notcontains' operation. */ notContains?: string; /** * A description for the '<>' operation. */ notEqual?: string; /** * A description for the 'startswith' operation. */ startsWith?: string; }; export type FilterType = 'exclude' | 'include'; export type FixedPosition = 'left' | 'right' | 'sticky'; /** * The base class for 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 interface GridBase { /** * Shows the load panel. */ beginCustomLoading(messageText: string): void; /** * Gets a data object with a specific key. */ byKey(key: TKey): DevExpress.core.utils.DxPromise; /** * Discards changes that a user made to data. */ cancelEditData(): void; /** * Gets the value of a cell with a specific row index and a data field, column caption or name. */ cellValue(rowIndex: number, dataField: string): any; /** * Sets a new value to a cell with a specific row index and a data field, column caption or name. */ cellValue(rowIndex: number, dataField: string, value: any): void; /** * Gets the value of a cell with specific row and column indexes. */ cellValue(rowIndex: number, visibleColumnIndex: number): any; /** * Sets a new value to a cell with specific row and column indexes. */ cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; /** * Clears all filters applied to UI component rows. */ clearFilter(): void; /** * Clears all row filters of a specific type. */ clearFilter(filterName: string): void; /** * Clears selection of all rows on all pages. */ clearSelection(): void; /** * Clears sorting settings of all columns at once. */ clearSorting(): void; /** * Switches the cell being edited back to the normal state. Takes effect only if editing.mode is batch or cell and showEditorAlways is false. */ closeEditCell(): void; /** * Collapses the currently expanded adaptive detail row (if there is one). */ collapseAdaptiveDetailRow(): void; /** * Gets the data column count. Includes visible and hidden columns, excludes command columns. */ columnCount(): number; /** * Gets all properties of a column with a specific identifier. */ columnOption(id: number | string): any; /** * Gets the value of a single column property. */ columnOption(id: number | string, optionName: string): any; /** * Updates the value of a single column property. */ columnOption( id: number | string, optionName: string, optionValue: any ): void; /** * Updates the values of several column properties. */ columnOption(id: number | string, options: any): void; /** * Removes a column. */ deleteColumn(id: number | string): void; /** * Removes a row with a specific index. */ deleteRow(rowIndex: number): void; /** * Clears the selection of all rows on all pages or the currently rendered page only. */ deselectAll(): DevExpress.core.utils.DxPromise; /** * Cancels the selection of rows with specific keys. */ deselectRows(keys: Array): DevExpress.core.utils.DxPromise; /** * Switches a cell with a specific row index and a data field to the editing state. Takes effect only if the editing mode is 'batch' or 'cell'. */ editCell(rowIndex: number, dataField: string): void; /** * Switches a cell with specific row and column indexes to the editing state. Takes effect only if the editing mode is 'batch' or 'cell'. */ editCell(rowIndex: number, visibleColumnIndex: number): void; /** * Switches a row with a specific index to the editing state. Takes effect only if the editing mode is 'row', 'popup' or 'form'. */ editRow(rowIndex: number): void; /** * Hides the load panel. */ endCustomLoading(): void; /** * Expands an adaptive detail row. */ expandAdaptiveDetailRow(key: TKey): void; /** * Gets a filter expression applied to the UI component's data source using the filter(filterExpr) method and the DataSource's filter property. */ filter(): any; /** * Applies a filter to the dataSource. */ filter(filterExpr: any): void; focus(): void; /** * Sets focus on a specific cell. */ focus(element: DevExpress.core.UserDefinedElement): void; /** * Gets a cell with a specific row index and a data field, column caption or name. */ getCellElement( rowIndex: number, dataField: string ): DevExpress.core.DxElement | undefined; /** * Gets a cell with specific row and column indexes. */ getCellElement( rowIndex: number, visibleColumnIndex: number ): DevExpress.core.DxElement | undefined; /** * Gets the total filter that combines all the filters applied. */ getCombinedFilter(): any; /** * Gets the total filter that combines all the filters applied. */ getCombinedFilter(returnDataField: boolean): any; getDataSource(): DevExpress.common.data.DataSource; /** * Gets the key of a row with a specific index. */ getKeyByRowIndex(rowIndex: number): TKey | undefined; /** * Gets the container of a row with a specific index. */ getRowElement( rowIndex: number ): DevExpress.core.UserDefinedElementsArray | undefined; /** * Gets the index of a row with a specific key. */ getRowIndexByKey(key: TKey): number; /** * Gets the instance of the UI component's scrollable part. */ getScrollable(): Scrollable; /** * Gets the index of a visible column. */ getVisibleColumnIndex(id: number | string): number; /** * Checks whether the UI component has unsaved changes. */ hasEditData(): boolean; /** * Hides the column chooser. */ hideColumnChooser(): void; /** * Checks whether an adaptive detail row is expanded or collapsed. */ isAdaptiveDetailRowExpanded(key: TKey): boolean; /** * Checks whether a row with a specific key is focused. */ isRowFocused(key: TKey): boolean; /** * Checks whether a row with a specific key is selected. */ isRowSelected(key: TKey): boolean; /** * Gets a data object's key. */ keyOf(obj: TRowData): TKey; /** * Navigates to a row with the specified key. */ navigateToRow(key: TKey): DevExpress.core.utils.DxPromise; /** * Gets the total page count. */ pageCount(): number; /** * Gets the current page index. */ pageIndex(): number; /** * Switches the UI component to a specific page using a zero-based index. */ pageIndex(newIndex: number): DevExpress.core.utils.DxPromise; /** * Gets the current page size. */ pageSize(): number; /** * Sets the page size. */ pageSize(value: number): void; /** * Reloads data and repaints data rows. */ refresh(): DevExpress.core.utils.DxPromise; /** * Reloads data and repaints all or only updated data rows. */ refresh(changesOnly: boolean): DevExpress.core.utils.DxPromise; /** * Repaints specific rows. */ repaintRows(rowIndexes: Array): void; /** * Saves changes that a user made to data. */ saveEditData(): DevExpress.core.utils.DxPromise; /** * Seeks a search string in the columns whose allowSearch property is true. */ searchByText(text: string): void; /** * Selects all rows. */ selectAll(): DevExpress.core.utils.DxPromise; /** * Selects rows with specific keys. */ selectRows( keys: Array, preserve: boolean ): DevExpress.core.utils.DxPromise>; /** * Selects rows with specific indexes. */ selectRowsByIndexes( indexes: Array ): DevExpress.core.utils.DxPromise>; /** * Shows the column chooser. */ showColumnChooser(): void; /** * Gets the current UI component state. */ state(): any; /** * Sets the UI component state. */ state(state: any): void; /** * Recovers a row deleted in batch editing mode. */ undeleteRow(rowIndex: number): void; /** * Updates the UI component's content after resizing. */ updateDimensions(): 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 GridBaseOptions< TComponent extends GridBase, TRowData = any, TKey = any > = Omit< GridBaseOptionsBlank, 'focusStateEnabled' > & { /** * Specifies whether a user can reorder columns. */ allowColumnReordering?: boolean; /** * Specifies whether a user can resize columns. */ allowColumnResizing?: boolean; /** * Automatically scrolls the component to the focused row when the focusedRowKey is changed. */ autoNavigateToFocusedRow?: boolean; /** * Specifies whether data should be cached. */ cacheEnabled?: boolean; /** * Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ cellHintEnabled?: boolean; /** * Specifies if the component adjusts column widths to fit content. */ columnAutoWidth?: boolean; /** * Configures the column chooser. */ columnChooser?: ColumnChooser; /** * Configures column fixing. */ columnFixing?: ColumnFixing; /** * Specifies whether the UI component should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is 'widget'. */ columnHidingEnabled?: boolean; /** * Specifies the minimum width of columns. */ columnMinWidth?: number | undefined; /** * Specifies how the UI component resizes columns. Applies only if allowColumnResizing is true. */ columnResizingMode?: ColumnResizeMode; /** * Specifies the width for all data columns. Has a lower priority than the column.width property. */ columnWidth?: number | Mode | undefined; /** * Overridden. */ columns?: Array | string> | undefined; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the format in which date-time values should be sent to the server. */ dateSerializationFormat?: string; /** * Overriden. */ editing?: EditingBase; /** * Indicates whether to show the error row. */ errorRowEnabled?: boolean; /** * Configures the integrated filter builder. */ filterBuilder?: DevExpress.ui.dxFilterBuilder.Properties; /** * Configures the popup in which the integrated filter builder is shown. */ filterBuilderPopup?: DevExpress.ui.dxPopup.Properties; /** * Configures the filter panel. */ filterPanel?: FilterPanel; /** * Configures the filter row. */ filterRow?: FilterRow; /** * Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue property. */ filterSyncEnabled?: boolean | Mode; /** * Specifies a filter expression. */ filterValue?: string | Array | Function; /** * The index of the column that contains the focused data cell. This index is taken from the columns array. */ focusedColumnIndex?: number; /** * Specifies whether the focused row feature is enabled. */ focusedRowEnabled?: boolean; /** * Specifies or indicates the focused data row's index. */ focusedRowIndex?: number; /** * Specifies initially or currently focused grid row's key. */ focusedRowKey?: TKey | undefined; /** * Configures the header filter feature. */ headerFilter?: HeaderFilter; /** * Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true. */ highlightChanges?: boolean; /** * Configures keyboard navigation. */ keyboardNavigation?: KeyboardNavigation; /** * Configures the load panel. */ loadPanel?: LoadPanel; /** * Specifies a text string shown when the widget does not display any data. */ noDataText?: string; /** * A function that is executed before an adaptive detail row is rendered. */ onAdaptiveDetailRowPreparing?: ( e: DevExpress.common.core.events.EventInfo & AdaptiveDetailRowPreparingInfo ) => void; /** * A function that is executed when an error occurs in the data source. */ onDataErrorOccurred?: ( e: DevExpress.common.core.events.EventInfo & DataErrorOccurredInfo ) => void; /** * A function that is executed after row changes are discarded. */ onEditCanceled?: ( e: DevExpress.common.core.events.EventInfo & DataChangeInfo ) => void; /** * A function that is executed when the edit operation is canceled, but row changes are not yet discarded. */ onEditCanceling?: ( e: DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & DataChangeInfo ) => void; /** * A function that is executed before a new row is added to the UI component. */ onInitNewRow?: ( e: DevExpress.common.core.events.EventInfo & NewRowInfo ) => void; /** * A function that is executed when the UI component is in focus and a key has been pressed down. */ onKeyDown?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent > & KeyDownInfo ) => void; /** * A function that is executed after a row is collapsed. */ onRowCollapsed?: ( e: DevExpress.common.core.events.EventInfo & RowKeyInfo ) => void; /** * A function that is executed before a row is collapsed. */ onRowCollapsing?: ( e: DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & RowKeyInfo ) => void; /** * A function that is executed after a row is expanded. */ onRowExpanded?: ( e: DevExpress.common.core.events.EventInfo & RowKeyInfo ) => void; /** * A function that is executed before a row is expanded. */ onRowExpanding?: ( e: DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & RowKeyInfo ) => void; /** * A function that is executed after a new row has been inserted into the data source. */ onRowInserted?: ( e: DevExpress.common.core.events.EventInfo & RowInsertedInfo ) => void; /** * A function that is executed before a new row is inserted into the data source. */ onRowInserting?: ( e: DevExpress.common.core.events.EventInfo & RowInsertingInfo ) => void; /** * A function that is executed after a row has been removed from the data source. */ onRowRemoved?: ( e: DevExpress.common.core.events.EventInfo & RowRemovedInfo ) => void; /** * A function that is executed before a row is removed from the data source. */ onRowRemoving?: ( e: DevExpress.common.core.events.EventInfo & RowRemovingInfo ) => void; /** * A function that is executed after a row has been updated in the data source. */ onRowUpdated?: ( e: DevExpress.common.core.events.EventInfo & RowUpdatedInfo ) => void; /** * A function that is executed before a row is updated in the data source. */ onRowUpdating?: ( e: DevExpress.common.core.events.EventInfo & RowUpdatingInfo ) => void; /** * A function that is executed after cells in a row are validated against validation rules. */ onRowValidating?: ( e: DevExpress.common.core.events.EventInfo & RowValidatingInfo ) => void; /** * A function that is executed after row changes are saved. */ onSaved?: ( e: DevExpress.common.core.events.EventInfo & DataChangeInfo ) => void; /** * A function that is executed before pending row changes are saved. */ onSaving?: ( e: DevExpress.common.core.events.EventInfo & SavingInfo ) => void; /** * A function that is executed after selecting a row or clearing its selection. */ onSelectionChanged?: ( e: DevExpress.common.core.events.EventInfo & SelectionChangedInfo ) => void; /** * A function that is executed before the toolbar is created. */ onToolbarPreparing?: ( e: DevExpress.common.core.events.EventInfo & ToolbarPreparingInfo ) => void; /** * Configures the pager. */ pager?: Pager; /** * Configures paging. */ paging?: PagingBase; /** * Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements. */ renderAsync?: boolean; /** * Specifies whether to repaint only those cells whose data changed. */ repaintChangesOnly?: boolean; /** * Specifies whether rows should be shaded differently. */ rowAlternationEnabled?: boolean; /** * Configures row reordering using drag and drop gestures. */ rowDragging?: RowDragging; /** * */ scrolling?: ScrollingBase; /** * Configures the search panel. */ searchPanel?: SearchPanel; /** * Allows you to select rows or determine which rows are selected. */ selectedRowKeys?: Array; /** * */ selection?: SelectionBase; /** * Specifies whether the outer borders of the UI component are visible. */ showBorders?: boolean; /** * Specifies whether column headers are visible. */ showColumnHeaders?: boolean; /** * Specifies whether vertical lines that separate one column from another are visible. */ showColumnLines?: boolean; /** * Specifies whether horizontal lines that separate one row from another are visible. */ showRowLines?: boolean; /** * Configures runtime sorting. */ sorting?: Sorting; /** * Configures state storing. */ stateStoring?: StateStoring; /** * Specifies whether to enable two-way data binding. */ twoWayBindingEnabled?: boolean; /** * Specifies whether text that does not fit into a column should be wrapped. */ wordWrapEnabled?: boolean; /** * Specifies whether to show only relevant values in the header filter and filter row. */ syncLookupFilterValues?: 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. */ interface GridBaseOptionsBlank< TComponent extends GridBase, TRowData = any, TKey = any > extends DevExpress.ui.WidgetOptions { /** * */ focusStateEnabled?: any; } export type GridsContextMenuTarget = | 'toolbar' | 'header' | 'content' | 'footer'; export type GridsEditMode = 'batch' | 'cell' | 'row' | 'form' | 'popup'; export type GridsEditRefreshMode = 'full' | 'reshape' | 'repaint'; export type GroupExpandMode = 'buttonClick' | 'rowClick'; /** * Configures the header filter feature. */ export type HeaderFilter = { /** * Specifies whether searching is enabled in the header filter. * @deprecated Use DataGrid search.enabled or TreeList search.enabled instead. */ allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies the height of the popup menu that contains values for filtering. */ height?: number | string; /** * Configures the header filter's search box. */ search?: HeaderFilterSearchConfig; /** * Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed. * @deprecated Use DataGrid search.timeout or TreeList search.timeout instead. */ searchTimeout?: number; /** * Contains properties that specify text for various elements of the popup menu. */ texts?: HeaderFilterTexts; /** * Specifies whether header filter icons are visible. */ visible?: boolean; /** * Specifies the width of the popup menu that contains values for filtering. */ width?: number | string; }; export type HeaderFilterGroupInterval = | 'day' | 'hour' | 'minute' | 'month' | 'quarter' | 'second' | 'year'; /** * Configures the header filter's search functionality. */ export type HeaderFilterSearchConfig = { /** * Configures the search box. */ editorOptions?: any; /** * Specifies whether search UI is enabled in the header filter. */ enabled?: boolean; /** * Specifies a comparison operation used to search header filter values. */ mode?: SearchMode; /** * Specifies a timeout, in milliseconds, during which a user may continue to modify the search value without starting the search operation. */ timeout?: number; }; /** * Contains properties that specify text for various elements of the popup menu. */ export type HeaderFilterTexts = { /** * Specifies text for the button that closes the popup menu without applying a filter. */ cancel?: string; /** * Specifies a name for the item that represents empty values in the popup menu. */ emptyValue?: string; /** * Specifies text for the button that applies the specified filter. */ ok?: string; }; /** * Configures keyboard navigation. */ export type KeyboardNavigation = { /** * Specifies whether users can enter a new cell value on a key press. Applies if editing.mode is 'cell' or 'batch'. */ editOnKeyPress?: boolean; /** * Enables keyboard navigation. */ enabled?: boolean; /** * Specifies whether the Enter key switches the cell or row to the edit state or moves focus in the enterKeyDirection. Applies for all edit modes, except 'popup'. */ enterKeyAction?: EnterKeyAction; /** * Specifies the direction in which to move focus when a user presses Enter. Applies if editing.mode is 'cell' or 'batch'. */ enterKeyDirection?: EnterKeyDirection; }; /** * * @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 KeyDownInfo = { /** * */ handled: boolean; }; /** * Configures the load panel. */ export type LoadPanel = { /** * Enables displaying the load panel automatically. */ enabled?: boolean | Mode; /** * Specifies the height of the load panel in pixels. */ height?: number | string; /** * Specifies a URL pointing to an image to be used as a loading indicator. */ indicatorSrc?: string; /** * 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; /** * Specifies whether to show the loading indicator. */ showIndicator?: boolean; /** * Specifies whether to show the pane of the load panel. */ showPane?: boolean; /** * Specifies text displayed on the load panel. */ text?: string; /** * Specifies the width of the load panel in pixels. */ width?: number | 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 interface NewRowInfo { /** * */ data: TRowData; /** * */ promise?: PromiseLike; } export type NewRowPosition = | 'first' | 'last' | 'pageBottom' | 'pageTop' | 'viewportBottom' | 'viewportTop'; /** * Configures the pager. */ export type Pager = PagerBase & { /** * Specifies the available page sizes in the page size selector. */ allowedPageSizes?: Array | Mode; /** * Specifies whether the pager is visible. */ visible?: boolean | Mode; }; export type PagerPageSize = 'all' | 'auto'; /** * Configures paging. * @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 PagingBase { /** * Enables paging. */ enabled?: boolean; /** * Specifies the page to be displayed using a zero-based index. */ pageIndex?: number; /** * Specifies the page size. */ pageSize?: number; } /** * Configures row reordering using drag and drop gestures. * @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 RowDragging< TComponent extends GridBase, TRowData = any, TKey = any > = { /** * Allows users to drop a row inside another row. */ allowDropInsideItem?: boolean; /** * Allows row reordering using drag and drop gestures. */ allowReordering?: boolean; /** * Enables automatic scrolling while dragging a row beyond the viewport. */ autoScroll?: boolean; /** * Specifies a DOM element that limits the dragging area. */ boundary?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies a custom container in which the draggable row should be rendered. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies the cursor offset from the dragged row. */ cursorOffset?: | string | { /** * Specifies the horizontal cursor offset from the dragged row in pixels. */ x?: number; /** * Specifies the vertical cursor offset from the dragged row in pixels. */ y?: number; }; /** * A container for custom data. */ data?: any | undefined; /** * Specifies the directions in which a row can be dragged. */ dragDirection?: DragDirection; /** * Specifies custom markup to be shown instead of the item being dragged. */ dragTemplate?: | template | (( dragInfo: RowDraggingTemplateData, containerElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies how to highlight the row's drop position. */ dropFeedbackMode?: DragHighlight; /** * Specifies a CSS selector for draggable rows. * @deprecated */ filter?: string; /** * Allows you to group several UI components so that users can drag and drop rows between them. */ group?: string | undefined; /** * Specifies a CSS selector (ID or class) for the element(s) that should act as the drag handle(s). */ handle?: string; /** * A function that is called when a new row is added. */ onAdd?: ( e: ReducedNativeEventInfo & RowDraggingEventInfo & DragDropInfo ) => void; /** * A function that is called when the dragged row's position is changed. */ onDragChange?: ( e: DevExpress.common.core.events.Cancelable & ReducedNativeEventInfo & RowDraggingEventInfo & DragDropInfo ) => void; /** * A function that is called when the drag gesture is finished. */ onDragEnd?: ( e: DevExpress.common.core.events.Cancelable & ReducedNativeEventInfo & RowDraggingEventInfo & DragDropInfo ) => void; /** * A function that is called every time a draggable row is moved. */ onDragMove?: ( e: DevExpress.common.core.events.Cancelable & ReducedNativeEventInfo & RowDraggingEventInfo & DragDropInfo ) => void; /** * A function that is called when the drag gesture is initialized. */ onDragStart?: ( e: DevExpress.common.core.events.Cancelable & ReducedNativeEventInfo & DragStartEventInfo ) => void; /** * A function that is called when a draggable row is removed. */ onRemove?: ( e: ReducedNativeEventInfo & RowDraggingEventInfo ) => void; /** * A function that is called when the draggable rows are reordered. */ onReorder?: ( e: ReducedNativeEventInfo & RowDraggingEventInfo & DragReorderInfo ) => void; /** * Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true. */ scrollSensitivity?: number; /** * Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true. */ scrollSpeed?: number; /** * Shows or hides row dragging icons. */ showDragIcons?: 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 interface RowDraggingEventInfo { readonly itemData?: TRowData; readonly itemElement: DevExpress.core.DxElement; readonly fromIndex: number; readonly toIndex: number; readonly fromComponent: Sortable | Draggable; readonly toComponent: Sortable | Draggable; readonly fromData?: any; readonly toData?: any; } export type RowDraggingTemplateData = { readonly itemData: TRowData; readonly itemElement: DevExpress.core.DxElement; }; /** * * @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 RowInsertedInfo = { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly error: Error; }; /** * * @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 RowInsertingInfo = { /** * */ data: TRowData; /** * */ cancel: boolean | PromiseLike | PromiseLike; }; /** * * @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 RowKeyInfo = { /** * */ readonly key: TKey; }; /** * * @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 RowRemovedInfo { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly error: Error; } /** * * @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 RowRemovingInfo { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ cancel: boolean | PromiseLike | PromiseLike; } /** * * @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 RowUpdatedInfo { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly error: Error; } /** * * @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 RowUpdatingInfo { /** * */ readonly oldData: TRowData; /** * */ newData: DevExpress.core.DeepPartial; /** * */ readonly key: TKey; /** * */ cancel: boolean | PromiseLike | PromiseLike; } /** * * @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 RowValidatingInfo { /** * */ readonly brokenRules: Array; /** * */ isValid: boolean; /** * */ readonly key: TKey; /** * */ readonly newData: DevExpress.core.DeepPartial; /** * @docid * @type object */ /** * */ readonly oldData: TRowData; /** * */ errorText: string; /** * */ promise?: PromiseLike; } /** * * @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 SavingInfo { /** * */ changes: Array>; /** * */ promise?: PromiseLike; /** * */ cancel: 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 interface ScrollingBase { /** * Specifies the rendering mode for columns. Applies when columns are left outside the viewport. Requires the columnWidth, columnAutoWidth, or width (for all columns) property specified. */ columnRenderingMode?: DataRenderMode; /** * Specifies whether the UI component should load adjacent pages. Applies only if scrolling.mode is 'virtual' or 'infinite'. */ preloadEnabled?: boolean; /** * Specifies the rendering mode for loaded rows. */ rowRenderingMode?: DataRenderMode; /** * Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is false. */ scrollByContent?: boolean; /** * Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false. */ scrollByThumb?: boolean; /** * Specifies when to show scrollbars. Applies only if useNative is false. */ showScrollbar?: ScrollbarMode; /** * Specifies whether the widget should use native or simulated scrolling. */ useNative?: boolean | Mode; /** * Specifies whether to render rows after a user stops scrolling or at the same time as the user scrolls the widget. */ renderAsync?: boolean | undefined; } /** * Configures the search panel. */ export type SearchPanel = { /** * Notifies the UI component whether search is case-sensitive to ensure that search results are highlighted correctly. Applies only if highlightSearchText is true. */ highlightCaseSensitive?: boolean; /** * Specifies whether found substrings should be highlighted. */ highlightSearchText?: boolean; /** * Specifies a placeholder for the search panel. */ placeholder?: string; /** * Specifies whether the UI component should search against all columns or only visible ones. */ searchVisibleColumnsOnly?: boolean; /** * Sets a search string for the search panel. */ text?: string; /** * Specifies whether the search panel is visible or not. */ visible?: boolean; /** * Specifies the width of the search panel in pixels. */ width?: string | number; }; export type SelectedFilterOperation = | '<' | '<=' | '<>' | '=' | '>' | '>=' | 'between' | 'contains' | 'endswith' | 'notcontains' | 'startswith'; /** * * @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 SelectionBase { /** * Allows users to simultaneously select all or current page rows (depending on the selectAllMode). */ allowSelectAll?: boolean; /** * Specifies the selection mode. */ mode?: SingleMultipleOrNone; } /** * * @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 SelectionChangedInfo { /** * */ readonly currentSelectedRowKeys: Array; /** * */ readonly currentDeselectedRowKeys: Array; /** * */ readonly selectedRowKeys: Array; /** * */ readonly selectedRowsData: Array; } export type SelectionColumnDisplayMode = | 'always' | 'none' | 'onClick' | 'onLongTap'; /** * Configures runtime sorting. */ export type Sorting = { /** * Specifies text for the context menu item that sets an ascending sort order in a column. */ ascendingText?: string; /** * Specifies text for the context menu item that clears sorting settings for a column. */ clearText?: string; /** * Specifies text for the context menu item that sets a descending sort order in a column. */ descendingText?: string; /** * Specifies the sorting mode. */ mode?: SingleMultipleOrNone; /** * Specifies whether to display sort indexes in column headers. Applies only when sorting.mode is 'multiple' and data is sorted by two or more columns. */ showSortIndexes?: boolean; }; export type StartEditAction = 'click' | 'dblClick'; export type StateStoreType = 'custom' | 'localStorage' | 'sessionStorage'; /** * Configures state storing. */ export type StateStoring = { /** * Specifies a function that is executed on state loading. Applies only if the type is 'custom'. */ customLoad?: () => PromiseLike; /** * Specifies a function that is executed on state change. Applies only if the type is 'custom'. */ customSave?: (gridState: any) => any; /** * Enables state storing. */ enabled?: boolean; /** * Specifies the delay in milliseconds between when a user makes a change and when this change is saved. */ savingTimeout?: number; /** * Specifies the key for storing the UI component state. */ storageKey?: string; /** * Specifies the type of storage where the state is saved. */ type?: StateStoreType; }; export type SummaryType = 'avg' | 'count' | 'custom' | 'max' | 'min' | 'sum'; /** * * @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 ToolbarPreparingInfo { /** * */ toolbarOptions: DevExpress.ui.dxToolbar.Properties; } } declare module DevExpress.core { /** * @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 ComponentFactory = { new ( element: UserDefinedElement, options?: Record ): TComponent; getInstance(element: UserDefinedElement): TComponent; }; /** * @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 Condition {} /** * @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 Condition extends JQueryEventObject {} /** * @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 Coordinates { left: number; top: number; } /** * @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 DeepPartial = | T | (T extends Scalar ? T : { [P in keyof T]?: DeepPartial; }); /** * 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(): DevExpress.common.core.environment.Device; /** * Overrides actual device information to force the application to operate as if it was running on a specified device. */ current( deviceName: string | DevExpress.common.core.environment.Device ): void; /** * Detaches all event handlers from a single event. */ off(eventName: DevExpress.common.EventName): this; /** * Detaches a particular event handler from a single event. */ off(eventName: DevExpress.common.EventName, eventHandler: Function): this; /** * Subscribes to an event. */ on(eventName: DevExpress.common.EventName, eventHandler: Function): this; /** * Subscribes to events. */ on(events: { [key in DevExpress.common.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(): DevExpress.common.core.environment.Device; isSimulator(): boolean; } /** * * @deprecated * @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 dxElement = DxElement; /** * * @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 DxElement = {} extends Condition ? T : ElementWrapper; /** * @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 dxElementWrapper { add(selector: string): this; addClass(className: string): this; after(element: Element | dxElementWrapper): this; append(element: Element | dxElementWrapper): this; appendTo(element: Element | dxElementWrapper): this; attr(attributeName: string, value: string | number | boolean | null): this; attr(attributeName: string): string | undefined; before(element: Element | dxElementWrapper): this; children(selector?: string): this; clone(): this; closest(selector: string | dxElementWrapper | Node): this; contents(): this; css(propertyName: string, value: string | number): this; css(properties: Record): this; css(propertyName: string): string | undefined; data(key: string, value?: any): this; detach(): this; each( func: (this: Element, index: number, element: Element) => boolean ): this; empty(): this; eq(index: number): this; filter(selector: string): this; find(selector_element: string | Element | dxElementWrapper): this; first(): this; get(index: number): Element; hasClass(className: string): boolean; hide(): this; html(value?: string): this; index(element?: Element | dxElementWrapper): number; insertAfter(element: Element | dxElementWrapper): this; insertBefore(element: Element | dxElementWrapper): this; is(selector: string | dxElementWrapper): boolean; last(): this; next(selector?: string): this; not(selector: string): this; offset(): Coordinates | undefined; offsetParent(): this; parent(selector?: string): this; parents(selector?: string): this; position(): Coordinates | undefined; prepend(element: Element | dxElementWrapper): this; prependTo(element: Element | dxElementWrapper): this; prev(): this; prop(propertyName: string, value: string | number | boolean): this; remove(element?: Element | dxElementWrapper): this; removeAttr(attributeName: string): this; removeClass(className: string): this; removeData(key: string): this; replaceWith(element: Element | dxElementWrapper): this; scrollLeft(value?: string | undefined): this; scrollTop(value?: string): this; show(): this; siblings(): this; slice(start?: number, end?: number): this; splice(start: number, deleteCount?: number): this; text(text: string | number | boolean): this; text(): string; toArray(): Element[]; toggle(value?: boolean | string): this; toggleClass(className: string, value?: boolean): this; trim(): this; val(value?: string | string[] | number): this; wrap(wrappingElement: this | Element | string): this; wrapInner(wrappingElement: this | Element | string): this; length: number; } /** * * @deprecated * @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 dxSVGElement = DxElement; /** * A custom template's markup. */ export type dxTemplate = Template; /** * * @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 dxTemplateOptions { /** * Specifies the name of the template. */ name?: 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 interface ElementsArrayWrapper {} /** * @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 ElementsArrayWrapper extends JQuery {} /** * @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 ElementWrapper {} /** * @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 ElementWrapper extends JQuery {} /** * @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 FunctionTemplate { render(template: { container: unknown; model?: object; transclude?: boolean; }): DxElement; } /** * @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 InternalElement = {} extends Condition ? dxElementWrapper : InternalElementWrapper; /** * @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 InternalElementWrapper {} /** * @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 InternalElementWrapper extends JQuery {} /** * @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 OmitInternal = Omit; /** * @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 PromiseType {} /** * @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 PromiseType extends JQueryPromise {} /** * @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 Scalar = | undefined | null | string | String | number | Number | bigint | BigInteger | boolean | Boolean | Date | Function | Symbol | Array; /** * @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 Template { constructor(options?: dxTemplateOptions); } /** * @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 TemplateManager { anonymousTemplateName: string; addDefaultTemplates(templates: Record): 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 UserDefinedElement = {} extends Condition ? T : ElementWrapper | T; /** * @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 UserDefinedElementsArray = {} extends Condition ? Array : ElementsArrayWrapper; } declare module DevExpress.core.utils { /** * @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 DxExtendedPromise = DxPromise & { then( onFulfilled?: | (( value: T, extraParameters?: any ) => TResult1 | PromiseLike) | undefined | null, onRejected?: | ((reason: any) => TResult2 | PromiseLike) | undefined | null ): PromiseLike; }; /** * * @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 DxPromise = {} extends PromiseType ? Promise : PromiseType; } declare module DevExpress.data { /** * * @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 DataSourceLike = | string | Array | DevExpress.data.utils.Store | DataSourceOptionsStub | DevExpress.common.data.DataSource; /** * @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 DataSourceOptionsStub< TStoreItem = any, TMappedItem = TStoreItem, TItem = TMappedItem > { customQueryParams?: any; expand?: Array | string; filter?: | DevExpress.common.data.FilterDescriptor | Array; group?: | DevExpress.common.data.GroupDescriptor | Array>; langParams?: DevExpress.common.data.LangParams; map?: (dataItem: TStoreItem) => TMappedItem; onChanged?: (e: { readonly changes?: Array }) => void; onLoadError?: (error: { readonly message?: string }) => void; onLoadingChanged?: (isLoading: boolean) => void; pageSize?: number; paginate?: boolean; postProcess?: (data: Array) => Array; pushAggregationTimeout?: number; requireTotalCount?: boolean; reshapeOnPush?: boolean; searchExpr?: string | Function | Array; searchOperation?: DevExpress.common.data.SearchOperation; searchValue?: any; select?: DevExpress.common.data.SelectDescriptor; sort?: | DevExpress.common.data.SortDescriptor | Array>; store?: | Array | DevExpress.data.utils.Store | DevExpress.data.utils.StoreOptions; } /** * @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 FilterDescriptor = 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 GroupDescriptor = | KeySelector | (OrderingDescriptor & { groupInterval?: number | GroupingInterval; isExpanded?: 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 GroupingInterval = | 'year' | 'quarter' | 'month' | 'day' | 'dayOfWeek' | 'hour' | 'minute' | 'second'; /** * The Guid is an object used to generate and contain a GUID. */ export class Guid { constructor(); constructor(value: string); /** * Gets the GUID. Works identically to the valueOf() method. */ toString(): string; /** * Gets the GUID. Works identically to the toString() method. */ valueOf(): 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 KeySelector = | string | ((source: T) => string | number | Date | Object); /** * @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 LoadOptions { /** * An object for storing additional settings that should be sent to the server. Relevant to the ODataStore only. */ customQueryParams?: any; /** * Specifies the start date of the date navigator range. Relevant to the Scheduler only. */ startDate?: Date; /** * Specifies the end date of the date navigator range. Relevant to the Scheduler only. */ endDate?: Date; /** * An array of strings that represent the names of navigation properties to be loaded simultaneously with the ODataStore. */ expand?: Array; /** * A filter expression. */ filter?: FilterDescriptor | Array; /** * A group expression. */ group?: GroupDescriptor | Array>; /** * A group summary expression. Used with the group setting. */ groupSummary?: SummaryDescriptor | Array>; /** * The IDs of the rows being expanded. Relevant only when the CustomStore is used in the TreeList UI component. */ parentIds?: Array; /** * Indicates whether a top-level group count is required. Used in conjunction with the filter, take, skip, requireTotalCount, and group settings. */ 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; /** * A comparison operation. */ searchOperation?: SearchOperation; /** * The current search value. */ searchValue?: any; /** * A select expression. */ select?: SelectDescriptor; /** * 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?: SortDescriptor | Array>; /** * The number of data objects to be loaded. In conjunction with skip, used to implement paging. */ take?: number; /** * A total summary expression. */ totalSummary?: SummaryDescriptor | Array>; /** * An object for storing additional settings that should be sent to the server. */ userData?: 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 OrderingDescriptor = SelectionDescriptor & { desc?: boolean; }; /** * The PivotGridDataSource is an object that provides an API for processing data from an underlying store. This object is used in the PivotGrid UI component. */ export class PivotGridDataSource { constructor(options?: DevExpress.data.PivotGridDataSource.Options); /** * Collapses all header items of a field with the specified identifier. */ collapseAll(id: number | string): void; /** * Collapses a specific header item. */ collapseHeaderItem(area: string, path: Array): void; /** * Provides access to the facts that were used to calculate a specific summary value. */ createDrillDownDataSource(options: { columnPath?: Array; rowPath?: Array; dataIndex?: number; maxRowCount?: number; customColumns?: Array; }): DevExpress.common.data.DataSource; /** * Disposes of all the resources allocated to the PivotGridDataSource instance. */ dispose(): void; /** * Expands all the header items of a field with the specified identifier. */ expandAll(id: number | string): void; /** * Expands a specific header item. */ expandHeaderItem(area: string, path: Array): void; /** * Gets all the properties of a field with the specified identifier. */ field(id: number | string): any; /** * Updates field options' values. */ field(id: number | string, options: any): void; /** * Gets all the fields including those generated automatically. */ fields(): Array; /** * Specifies a new fields collection. */ fields(fields: Array): void; /** * Gets the filter property's value. Does not affect an XmlaStore. */ filter(): any; /** * Sets the filter property's value. Does not affect an XmlaStore. */ filter(filterExpr: any): void; /** * Gets all the fields within an area. */ getAreaFields( area: string, collectGroups: boolean ): Array; /** * Gets the loaded data. Another data portion is loaded every time a header item is expanded. */ getData(): any; /** * Checks whether the PivotGridDataSource is loading data. */ isLoading(): boolean; /** * Starts loading data. */ load(): DevExpress.core.utils.DxPromise; /** * Detaches all event handlers from a single event. */ off(eventName: DevExpress.data.PivotGridDataSource.EventName): this; /** * Detaches a particular event handler from a single event. */ off( eventName: DevExpress.data.PivotGridDataSource.EventName, eventHandler: Function ): this; /** * Subscribes to an event. */ on( eventName: DevExpress.data.PivotGridDataSource.EventName, eventHandler: Function ): this; /** * Subscribes to events. */ on(events: { [key in DevExpress.data.PivotGridDataSource.EventName]?: Function; }): this; /** * Clears the loaded PivotGridDataSource data and calls the load() method. */ reload(): DevExpress.core.utils.DxPromise; /** * Gets the current PivotGridDataSource state. Part of the PivotGrid UI component's state storing feature. */ state(): any; /** * Sets the PivotGridDataSource state. Part of the PivotGrid UI component's state storing feature. */ state(state: any): void; } module PivotGridDataSource { /** * @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. */ type EventName = | 'changed' | 'fieldsPrepared' | 'loadError' | 'loadingChanged'; export type Options = PivotGridDataSourceOptions; export type PivotGridArea = 'column' | 'data' | 'filter' | 'row'; export type PivotGridDataType = 'date' | 'number' | 'string'; export type PivotGridGroupInterval = | 'day' | 'dayOfWeek' | 'month' | 'quarter' | 'year'; export type PivotGridRunningTotalMode = 'column' | 'row'; export type PivotGridSortBy = 'displayText' | 'value' | 'none'; export type PivotGridStoreType = 'array' | 'local' | 'odata' | 'xmla'; export type PivotGridSummaryDisplayMode = | 'absoluteVariation' | 'percentOfColumnGrandTotal' | 'percentOfColumnTotal' | 'percentOfGrandTotal' | 'percentOfRowGrandTotal' | 'percentOfRowTotal' | 'percentVariation'; } /** * @deprecated Use Field instead * @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 PivotGridDataSourceField { /** * Specifies whether to take neighboring groups' summary values into account when calculating a running total and absolute or percent variation. */ allowCrossGroupCalculation?: boolean; /** * Allows users to expand/collapse all header items within the same header level. Ignored if the PivotGridDataSource's paginate property is true. */ allowExpandAll?: boolean; /** * Specifies whether a user can filter the field's values. */ allowFiltering?: boolean; /** * Specifies whether a user can change the field's sorting. */ allowSorting?: boolean; /** * Allows users to sort the pivot grid by summary values instead of field values. Ignored if the PivotGridDataSource's paginate property is true. */ allowSortingBySummary?: boolean; /** * Specifies the field's area. */ area?: DevExpress.data.PivotGridDataSource.PivotGridArea | undefined; /** * Specifies the field's order among the other fields in the same area. Corresponds to the field's order in the fields array by default. */ areaIndex?: number; /** * Specifies a custom aggregate function. Applies only if the summaryType is 'custom' and the remoteOperations is false. Cannot be used with an XmlaStore. */ calculateCustomSummary?: (options: { summaryProcess?: string; value?: any; totalValue?: any; }) => void; /** * Specifies a custom post-processing function for summary values. */ calculateSummaryValue?: ( e: DevExpress.ui.dxPivotGridSummaryCell ) => number | null; /** * Specifies the field's caption to be displayed in the field chooser and on the field panel. */ caption?: string; /** * Customizes the text displayed in summary cells. */ customizeText?: (cellInfo: { value?: string | number | Date; valueText?: string; }) => string; /** * Specifies which data source field provides data for the pivot grid field. */ dataField?: string; /** * Casts field values to a specific data type. */ dataType?: DevExpress.data.PivotGridDataSource.PivotGridDataType; /** * Specifies the name of the directory in which the field is located when displayed in the field chooser. */ displayFolder?: string; /** * Specifies whether to expand all items within the field's header level. */ expanded?: boolean; /** * Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. */ filterType?: DevExpress.common.grids.FilterType; /** * Specifies the values by which the field is filtered. */ filterValues?: Array; /** * Formats field values before they are displayed. */ format?: DevExpress.common.core.localization.Format; /** * Specifies the field's index within its group. */ groupIndex?: number; /** * Specifies how the field's values are combined into groups for the headers. Cannot be used with an XmlaStore. */ groupInterval?: | DevExpress.data.PivotGridDataSource.PivotGridGroupInterval | number; /** * Specifies the name of the field's group. */ groupName?: string; /** * Configures the field's header filter. */ headerFilter?: { allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; height?: number; /** * Configures the header filter's search functionality. */ search?: DevExpress.common.grids.HeaderFilterSearchConfig; width?: number; }; /** * Specifies whether the field should be treated as a measure (a field providing data for calculation). */ isMeasure?: boolean; /** * Specifies the field's unique identifier. */ name?: string; /** * Specifies whether to calculate the running total by rows or by columns. */ runningTotal?: DevExpress.data.PivotGridDataSource.PivotGridRunningTotalMode; /** * Specifies a function that combines field values into groups. */ selector?: Function; /** * Specifies whether to display the field's grand totals. Applies only if the field is in the data area. */ showGrandTotals?: boolean; /** * Specifies whether to display the field's totals. */ showTotals?: boolean; /** * Specifies whether to display the field's summary values. Applies only if the field is in the data area. Inherits the showTotals' value by default. */ showValues?: boolean; /** * Specifies how the field's values in the headers should be sorted. */ sortBy?: DevExpress.data.PivotGridDataSource.PivotGridSortBy; /** * Sorts the field's values in the headers by the specified measure's summary values. Accepts the measure's name, caption, dataField, or index in the fields array. */ sortBySummaryField?: string; /** * Specifies a path to the column or row whose summary values should be used to sort the field's values in the headers. */ sortBySummaryPath?: Array; /** * Specifies the field values' sorting order. */ sortOrder?: DevExpress.common.SortOrder; /** * Specifies a custom comparison function that sorts the field's values in the headers. */ sortingMethod?: ( a: { value?: string | number; children?: Array }, b: { value?: string | number; children?: Array } ) => number; /** * Specifies a predefined post-processing function. Does not apply when the calculateSummaryValue property is set. */ summaryDisplayMode?: DevExpress.data.PivotGridDataSource.PivotGridSummaryDisplayMode; /** * Specifies how to aggregate the field's data. Cannot be used with an XmlaStore. */ summaryType?: DevExpress.common.grids.SummaryType | string; /** * Specifies whether the field is visible in the pivot grid and field chooser. */ visible?: boolean; /** * Specifies the field's width in pixels when the field is displayed in the pivot grid. */ width?: number; /** * Specifies whether text that does not fit into a header item should be wrapped. */ wordWrapEnabled?: boolean; } /** * * @deprecated * @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 PivotGridDataSourceOptions { /** * Configures pivot grid fields. */ fields?: Array; /** * Specifies data filtering conditions. Cannot be used with an XmlaStore. */ filter?: string | Array | Function; /** * A function that is executed after data is successfully loaded. */ onChanged?: Function; /** * A function that is executed when all fields are loaded from the store and they are ready to be displayed in the PivotGrid. */ onFieldsPrepared?: ( fields: Array ) => void; /** * A function that is executed when data loading fails. */ onLoadError?: (error: any) => void; /** * A function that is executed when the data loading status changes. */ onLoadingChanged?: (isLoading: boolean) => void; /** * Specifies whether the PivotGridDataSource should load data in portions. Can be used only with an XmlaStore. */ paginate?: boolean; /** * Specifies whether the data processing operations (filtering, grouping, summary calculation) should be performed on the server. */ remoteOperations?: boolean; /** * Specifies whether to auto-generate pivot grid fields from the store's data. */ retrieveFields?: boolean; /** * Configures the DataSource's underlying store. */ store?: | DevExpress.data.utils.Store | DevExpress.data.utils.StoreOptions | XmlaStore | (XmlaStoreOptions & { type: 'xmla' }) | Array<{ /** * Specifies the PivotGridDataSource's storage type. */ type?: DevExpress.data.PivotGridDataSource.PivotGridStoreType; }> | { /** * Specifies the PivotGridDataSource's storage type. */ type?: DevExpress.data.PivotGridDataSource.PivotGridStoreType; }; } /** * @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 SearchOperation = | '=' | '<>' | '>' | '>=' | '<' | '<=' | 'startswith' | 'endswith' | 'contains' | 'notcontains'; /** * @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 SelectDescriptor = | string | Array | ((source: T) => 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 SelectionDescriptor = { selector: KeySelector; }; /** * @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 SortDescriptor = KeySelector | OrderingDescriptor; /** * @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. */ type StoreEventName = | 'loaded' | 'loading' | 'inserted' | 'inserting' | 'updated' | 'updating' | 'push' | 'removed' | 'removing' | 'modified' | 'modifying'; /** * @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 SummaryDescriptor = | KeySelector | (SelectionDescriptor & { summaryType?: 'sum' | 'avg' | 'min' | 'max' | 'count'; }); /** * The XmlaStore is a store that provides an interface for accessing an OLAP cube according to the XMLA standard. */ export class XmlaStore { constructor(options?: XmlaStoreOptions); } /** * * @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 XmlaStoreOptions { /** * Specifies a function that customizes the request before it is sent to the server. */ beforeSend?: (options: { url?: string; method?: string; headers?: any; xhrFields?: any; data?: string; dataType?: string; }) => void; /** * Specifies the database (or initial catalog) that contains the OLAP cube to use. */ catalog?: string; /** * Specifies the name of the OLAP cube to use from the catalog. */ cube?: string; /** * Specifies the OLAP server's URL. */ url?: string; } } declare module DevExpress.data.ArrayStore { /** * @deprecated Use DevExpress.common.data.ArrayStoreOptions from /common/data instead */ export type Options< TItem = any, TKey = any > = DevExpress.common.data.ArrayStoreOptions; } declare module DevExpress.data.CustomStore { /** * @deprecated Use DevExpress.common.data.CustomStoreOptions from /common/data instead */ export type Options< TItem = any, TKey = any > = DevExpress.common.data.CustomStoreOptions; } declare module DevExpress.data.LocalStore { /** * @deprecated Use DevExpress.common.data.LocalStoreOptions from /common/data instead */ export type Options< TItem = any, TKey = any > = DevExpress.common.data.LocalStoreOptions; } declare module DevExpress.data.ODataStore { export type Options< TItem = any, TKey = any > = DevExpress.common.data.ODataStoreOptions; } declare module DevExpress.data.PivotGridDataSource { /** * Configures pivot grid fields. */ export type Field = PivotGridDataSourceField; } declare module DevExpress.data.utils { export type Store = | DevExpress.common.data.CustomStore | DevExpress.common.data.ArrayStore | DevExpress.common.data.LocalStore | DevExpress.common.data.ODataStore; export type StoreOptions = | DevExpress.common.data.CustomStoreOptions | (DevExpress.common.data.ArrayStoreOptions & { type: 'array'; }) | (DevExpress.common.data.LocalStoreOptions & { type: 'local'; }) | (DevExpress.common.data.ODataStoreOptions & { type: 'odata'; }); } declare module DevExpress.events { /** * * @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 DxEvent = {} extends EventType ? EventObject & TNativeEvent : Omit & { /** * */ originalEvent: TNativeEvent; }; /** * * @deprecated * @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 event = DxEvent; /** * @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 EventObject = { /** * The DOM element within the current event propagation stage. */ currentTarget: Element; /** * Data passed to the event handler. */ data: any; /** * The DOM element to which the currently-called event handler was attached. */ delegateTarget: Element; /** * The native JavaScript event contained in the DevExtreme event. */ originalEvent: TNativeEvent; /** * The DOM element that initiated the event. */ target: Element; /** * 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; }; /** * * @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 eventsHandler(event: DxEvent, extraParameters: any): 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 interface EventType {} /** * @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 EventType extends JQueryEventObject { cancel?: 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 InteractionEvent = PointerInteractionEvent | KeyboardEvent; /** * @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 PointerInteractionEvent = MouseEvent | TouchEvent | PointerEvent; /** * * @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 triggerHandler( element: Element | Array, event: string | DxEvent ): 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 function triggerHandler( element: Element | Array, event: string | DxEvent, extraParameters: any ): void; } declare module DevExpress.excelExporter { /** * */ export interface CellAddress { /** * The index of a row that contains the cell. */ row?: number; /** * The index of a column that contains the cell. */ column?: number; } /** * The coordinates of the exported DataGrid in the Excel file. */ export interface CellRange { /** * Coordinates of the top left cell. */ from?: CellAddress; /** * Coordinates of the bottom right cell. */ to?: CellAddress; } /** * @deprecated Use DataGridCell instead * @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 ExcelDataGridCell { /** * The configuration of the cell's column. */ column?: DevExpress.ui.dxDataGrid.Column; /** * The data object of the cell's row. */ data?: any; /** * The group index of the cell's row. Available when the rowType is 'group'. */ groupIndex?: number; /** * Information about group summary items the cell represents. */ groupSummaryItems?: Array<{ /** * The group summary item's identifier. */ name?: string; /** * The group summary item's raw value. */ value?: any; }>; /** * The type of the cell's row. */ rowType?: string; /** * The identifier of the total summary item that the cell represents. */ totalSummaryItemName?: string; /** * The cell's raw value. */ value?: 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 interface ExcelExportBaseOptions { /** * An Excel worksheet to which the grid should be exported. */ worksheet?: object | undefined; /** * A cell used as a start position for export. */ topLeftCell?: CellAddress | string; /** * Specifies whether Excel columns should have the same width as their source UI component's columns. */ keepColumnWidths?: boolean; /** * Configures the load panel. */ loadPanel?: ExportLoadPanel; /** * Specifies if the CSV export routine saves potentially dangerous content as plain text data. */ encodeExecutableContent?: boolean; } /** * @deprecated Use PivotGridCell instead * @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 ExcelPivotGridCell extends DevExpress.ui.dxPivotGrid.Cell { /** * The area to which the cell belongs. */ area?: 'column' | 'row' | 'data'; /** * A zero-based index that indicates the position of the cell's row. */ rowIndex?: number; /** * A zero-based index that indicates the position of the cell's column. */ columnIndex?: number; /** * The header type. Available if the cell belongs to the field panel. */ headerType?: 'column' | 'row' | 'data' | 'filter'; } } declare module DevExpress.fileManagement { /** * A custom file system provider allows you to implement custom APIs to access and use file systems. */ export class CustomFileSystemProvider extends FileSystemProviderBase { constructor( options?: DevExpress.fileManagement.CustomFileSystemProvider.Options ); } module CustomFileSystemProvider { export type Options = CustomFileSystemProviderOptions; } /** * * @deprecated * @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 CustomFileSystemProviderOptions extends FileSystemProviderBaseOptions { /** * A function that cancels the file upload. */ abortFileUpload?: ( file: File, uploadInfo: UploadInfo, destinationDirectory: FileSystemItem ) => PromiseLike | any; /** * A function that copies files or directories. */ copyItem?: ( item: FileSystemItem, destinationDirectory: FileSystemItem ) => PromiseLike | any; /** * A function that creates a directory. */ createDirectory?: ( parentDirectory: FileSystemItem, name: string ) => PromiseLike | any; /** * A function that deletes a file or directory. */ deleteItem?: (item: FileSystemItem) => PromiseLike | any; /** * A function that downloads files. */ downloadItems?: (items: Array) => void; /** * A function that gets file system items. */ getItems?: ( parentDirectory: FileSystemItem ) => PromiseLike> | Array; /** * A function that get items content. */ getItemsContent?: (items: Array) => PromiseLike | any; /** * A function or the name of a data source field that provides information on whether a file or directory contains sub directories. */ hasSubDirectoriesExpr?: string | Function; /** * A function that moves files and directories. */ moveItem?: ( item: FileSystemItem, destinationDirectory: FileSystemItem ) => PromiseLike | any; /** * A function that renames files and directories. */ renameItem?: ( item: FileSystemItem, newName: string ) => PromiseLike | any; /** * A function that uploads a file in chunks. */ uploadFileChunk?: ( file: File, uploadInfo: UploadInfo, destinationDirectory: FileSystemItem ) => PromiseLike | any; } /** * An object that contains information about the error. */ export class FileSystemError { constructor( errorCode?: number, fileSystemItem?: FileSystemItem, errorText?: string ); /** * The processed file or directory. */ fileSystemItem?: FileSystemItem; /** * The error code. */ errorCode?: number; /** * The error message. */ errorText?: string; } /** * An object that provides information about a file system item (file or directory) in the FileManager UI component. */ export class FileSystemItem { constructor(path: string, isDirectory: boolean, pathKeys?: Array); /** * The file system item's path. */ path: string; /** * The file system item's path specified in keys. */ pathKeys: Array; /** * The file system item's key. */ key: string; /** * The file system item's name. */ name: string; /** * A timestamp that indicates when the file system item was last modified. */ dateModified: Date; /** * The file system item's size (in bytes). */ size: number; /** * Specifies whether the file system item is a directory. */ isDirectory: boolean; /** * Specifies whether a directory has subdirectories. */ hasSubDirectories: boolean; /** * An icon (URL) to be used as the file system item's thumbnail. */ thumbnail: string; /** * The file system data object that stores information about the file system item (name, size, modification date, etc.). */ dataItem: any; /** * Gets a file's extension. */ getFileExtension(): string; } /** * Contains base provider settings. * @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 FileSystemProviderBase { constructor(options?: FileSystemProviderBaseOptions); /** * Gets file system items. */ getItems( parentDirectory: FileSystemItem ): DevExpress.core.utils.DxPromise>; /** * Renames a file or directory. */ renameItem( item: FileSystemItem, newName: string ): DevExpress.core.utils.DxPromise; /** * Creates a directory. */ createDirectory( parentDirectory: FileSystemItem, name: string ): DevExpress.core.utils.DxPromise; /** * Deletes files or directories. */ deleteItems( items: Array ): Array>; /** * Moves files and directories. */ moveItems( items: Array, destinationDirectory: FileSystemItem ): Array>; /** * Copies files or directories. */ copyItems( items: Array, destinationDirectory: FileSystemItem ): Array>; /** * Uploads a file in chunks. */ uploadFileChunk( fileData: File, uploadInfo: UploadInfo, destinationDirectory: FileSystemItem ): DevExpress.core.utils.DxPromise; /** * Cancels the file upload. */ abortFileUpload( fileData: File, uploadInfo: UploadInfo, destinationDirectory: FileSystemItem ): DevExpress.core.utils.DxPromise; /** * Downloads files. */ downloadItems(items: Array): void; /** * Gets items content. */ getItemsContent( items: Array ): DevExpress.core.utils.DxPromise; } /** * * @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 FileSystemProviderBaseOptions { /** * Specifies which data field provides timestamps that indicate when a file was last modified. */ dateModifiedExpr?: string | Function; /** * Specifies which data field provides information about whether a file system item is a directory. */ isDirectoryExpr?: string | Function; /** * Specifies the data field that provides keys. */ keyExpr?: string | Function; /** * Specifies which data field provides file and directory names. */ nameExpr?: string | Function; /** * Specifies which data field provides file sizes. */ sizeExpr?: string | Function; /** * Specifies which data field provides icons to be used as thumbnails. */ thumbnailExpr?: string | Function; } /** * The Object file system provider works with a file system represented by an in-memory array of JSON objects. */ export class ObjectFileSystemProvider extends FileSystemProviderBase { constructor( options?: DevExpress.fileManagement.ObjectFileSystemProvider.Options ); } module ObjectFileSystemProvider { export type Options = ObjectFileSystemProviderOptions; } /** * * @deprecated * @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 ObjectFileSystemProviderOptions extends FileSystemProviderBaseOptions { /** * Specifies which data field provides information about files content. */ contentExpr?: string | Function; /** * Specifies an array of data objects that represent files and directories. */ data?: Array; /** * Specifies which data field provides information about nested files and directories. */ itemsExpr?: string | Function; } /** * The Remote file system provider works with a file system located on the server. */ export class RemoteFileSystemProvider extends FileSystemProviderBase { constructor( options?: DevExpress.fileManagement.RemoteFileSystemProvider.Options ); } module RemoteFileSystemProvider { export type Options = RemoteFileSystemProviderOptions; } /** * * @deprecated * @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 RemoteFileSystemProviderOptions extends FileSystemProviderBaseOptions { /** * Specifies a function that customizes an Ajax request before it is sent to the server. */ beforeAjaxSend?: (options: { headers?: any; xhrFields?: any; formData?: any; }) => void; /** * Specifies a function that customizes a form submit request before it is sent to the server. */ beforeSubmit?: (options: { formData?: any }) => void; /** * Specifies the URL of an endpoint used to access and modify a file system located on the server. */ endpointUrl?: string; /** * Specifies which data field provides information about whether a directory has subdirectories. */ hasSubDirectoriesExpr?: string | Function; /** * Specifies the request headers. */ requestHeaders?: any; } /** * An object that provides information about the file upload session. */ export interface UploadInfo { /** * The number of bytes that is uploaded to the server. */ bytesUploaded: number; /** * The number of uploaded chunks and chunks that are to be uploaded. */ chunkCount: number; /** * Custom information that you can pass during file upload. For instance, you can specify a custom file ID when the first part of a file is being uploaded. */ customData: any; /** * The binary content of the uploading chunk. */ chunkBlob: Blob; /** * The index of the uploading chunk. */ chunkIndex: number; } } declare module DevExpress.pdfExporter { /** * @deprecated Use DataGridCell instead * @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 PdfDataGridCell extends DevExpress.common.Export.excel.DataGridCell {} } declare module DevExpress.ui { /** * An object that describes an appointment in the Scheduler UI component. */ export type Appointment = dxSchedulerAppointment; /** * Specifies dependency between the screen factor and the count of columns. * @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 ColCountResponsible { /** * The count of columns for a large screen size. */ lg?: number | undefined; /** * The count of columns for a middle-sized screen. */ md?: number | undefined; /** * The count of columns for a small-sized screen. */ sm?: number | undefined; /** * The count of columns for an extra small-sized screen. */ xs?: number | undefined; } /** * The base class for UI components containing an item collection. * @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 CollectionWidget< TProperties extends CollectionWidgetOptions, TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends Widget { getDataSource(): DevExpress.common.data.DataSource; } module CollectionWidget { /** * @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 ItemLike = string | CollectionWidgetItem | 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 interface SelectionChangeInfo { /** * */ readonly addedItems: Array; /** * */ readonly removedItems: Array; } /** * @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 SelectionChangingEventBase = DevExpress.common.core.events.AsyncCancelable & DevExpress.common.core.events.EventInfo & SelectionChangeInfo; } /** * * @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 CollectionWidgetItem { /** * Specifies whether the UI component item responds to user interaction. */ disabled?: boolean; /** * Specifies the HTML markup to be inserted into the item element. */ html?: string; /** * Specifies a template that should be used to render this item only. */ template?: | template | (( itemData: this, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies text displayed for the UI component item. */ text?: string; /** * Specifies whether or not a UI component item must be displayed. */ visible?: 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 interface CollectionWidgetOptions< TComponent extends CollectionWidget | any, TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends WidgetOptions { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * The time period in milliseconds before the onItemHold event is raised. */ itemHoldTimeout?: number; /** * Specifies a custom template for items. */ itemTemplate?: | template | (( itemData: TItem, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies the key property that provides key values to access data items. Each key value must be unique. */ keyExpr?: string | Function; /** * Specifies the text or HTML markup displayed by the UI component if the item collection is empty. */ noDataText?: string; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick?: | (( e: DevExpress.common.core.events.NativeEventInfo< TComponent, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo ) => void) | string; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo ) => void; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo ) => void; /** * A function that is executed after a collection item is rendered. */ onItemRendered?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ItemInfo ) => void; /** * A function that is called before selection changes. */ onSelectionChanging?: ( e: DevExpress.ui.CollectionWidget.SelectionChangingEventBase ) => void; /** * A function that is called after selection changes. */ onSelectionChanged?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.ui.CollectionWidget.SelectionChangeInfo ) => void; /** * The index of the currently selected UI component item. */ selectedIndex?: number; /** * The selected item object. */ selectedItem?: TItem; /** * Specifies an array of currently selected item keys. */ selectedItemKeys?: Array; /** * An array of currently selected item objects. */ selectedItems?: Array; } export interface CustomDialogOptions { title?: string; messageHtml?: string; buttons?: Array; showTitle?: boolean; message?: string; dragEnabled?: 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 class DataExpressionMixin { constructor(options?: DataExpressionMixinOptions); getDataSource(): DevExpress.common.data.DataSource; } /** * * @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 DataExpressionMixinOptions { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike< CollectionWidgetItem | any > | null; /** * Specifies the data field whose values should be displayed. */ displayExpr?: string | ((item: any) => string) | undefined; /** * Specifies a custom template for items. */ itemTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies the currently selected value. May be an object if dataSource contains objects, the store key is specified, and valueExpr is not set. */ value?: any; /** * Specifies which data field provides unique values to the UI component's value. */ valueExpr?: string | ((item: any) => string | number | boolean); } /** * A drop-down editor UI component. * @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 DateBoxBase< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.dxDateBox.Properties > extends dxDropDownEditor { /** * Closes the drop-down editor. */ close(): void; /** * Opens the drop-down editor. */ open(): 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 DateBoxBaseOptions extends dxDropDownEditorOptions { /** * Specifies the Apply button's text. */ applyButtonText?: string; /** * Configures the calendar's value picker. */ calendarOptions?: dxCalendarOptions; /** * Specifies the Cancel button's text. */ cancelButtonText?: string; /** * Specifies the date value serialization format. */ dateSerializationFormat?: string | undefined; /** * Specifies the date's display format. */ displayFormat?: DevExpress.common.core.localization.Format; /** * The latest date that can be selected in the UI component. */ max?: DevExpress.common.DateLike | undefined; /** * The earliest date that can be selected in the UI component. */ min?: DevExpress.common.DateLike | undefined; /** * Specified the Today button's text. */ todayButtonText?: string; /** * Specifies whether to use an input mask based on the displayFormat property. */ useMaskBehavior?: boolean; /** * Configures the drop-down that holds the content. */ dropDownOptions?: DevExpress.ui.dxPopup.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 const DateRangeBoxBase: Omit & (new ( element: DevExpress.core.UserDefinedElement, options?: DevExpress.ui.dxDateRangeBox.Properties ) => Omit< DateBoxBase, 'field' | 'reset' >); /** * * @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 DraggableBase {} /** * * @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 DraggableBaseOptions extends DOMComponentOptions { /** * Enables automatic scrolling while dragging an item beyond the viewport. */ autoScroll?: boolean; /** * Specifies a DOM element that limits the dragging area. */ boundary?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies a custom container in which the draggable item should be rendered. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies the cursor offset from the dragged item. */ cursorOffset?: | string | { /** * Specifies the horizontal cursor offset from the dragged item in pixels. */ x?: number; /** * Specifies the vertical cursor offset from the dragged item in pixels. */ y?: number; }; /** * A container for custom data. */ data?: any | undefined; /** * Specifies the directions in which an item can be dragged. */ dragDirection?: DevExpress.common.DragDirection; /** * Allows you to group several UI components, so that users can drag and drop items between them. */ group?: string | undefined; /** * Specifies a CSS selector (ID or class) that should act as the drag handle(s) for the item(s). */ handle?: string; /** * Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true. */ scrollSensitivity?: number; /** * Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true. */ scrollSpeed?: number; } /** * The Accordion UI component contains several panels displayed one under another. These panels can be collapsed or expanded by an end user, which makes this UI component very useful for presenting information in a limited amount of space. */ export class dxAccordion< TItem extends DevExpress.ui.dxAccordion.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> { /** * Collapses an item with a specific index. */ collapseItem(index: number): DevExpress.core.utils.DxPromise; /** * Expands an item with a specific index. */ expandItem(index: number): DevExpress.core.utils.DxPromise; /** * Updates the dimensions of the UI component contents. */ updateDimensions(): DevExpress.core.utils.DxPromise; } module dxAccordion { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; ItemTitleClickEvent: ItemTitleClickEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxAccordion >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxAccordion, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxAccordion, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxAccordion, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the itemTitleClick event handler's argument. */ export type ItemTitleClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxAccordion, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxAccordionOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; } /** * @deprecated Use Item instead * @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 dxAccordionItem extends CollectionWidgetItem { /** * Specifies the icon to be displayed in the panel's title. */ icon?: string; /** * Specifies text displayed for the UI component item title. */ title?: string; /** * Specifies a template that should be used to render the title for this item only. */ titleTemplate?: | template | (() => string | DevExpress.core.UserDefinedElement); } /** * * @deprecated */ export interface dxAccordionOptions< TItem extends DevExpress.ui.dxAccordion.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel. */ animationDuration?: number; /** * Specifies whether all items can be collapsed or whether at least one item must always be expanded. */ collapsible?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether to render the panel's content when it is displayed. If false, the content is rendered immediately. */ deferRendering?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies the UI component's height. */ height?: number | string | undefined; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies a custom template for items. */ itemTemplate?: | template | (( itemData: TItem, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for item titles. */ itemTitleTemplate?: | template | (( itemData: TItem, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies whether the UI component can expand several items or only a single item at once. */ multiple?: boolean; /** * A function that is executed when an accordion item's title is clicked or tapped. */ onItemTitleClick?: | (( e: DevExpress.ui.dxAccordion.ItemTitleClickEvent ) => void) | string; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly?: boolean; /** * The index number of the currently expanded item. */ selectedIndex?: number; } /** * The ActionSheet UI component is a sheet containing a set of buttons located one under the other. These buttons usually represent several choices relating to a single task. */ export class dxActionSheet< TItem extends DevExpress.ui.dxActionSheet.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> { /** * Hides the UI component. */ hide(): DevExpress.core.utils.DxPromise; /** * Shows the UI component. */ show(): DevExpress.core.utils.DxPromise; /** * Shows or hides the UI component depending on the argument. */ toggle(showing: boolean): DevExpress.core.utils.DxPromise; } module dxActionSheet { /** * The type of the cancelClick event handler's argument. */ export type CancelClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo>; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes, TKey> = { Properties: Properties; CancelClickEvent: CancelClickEvent; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxActionSheet >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxActionSheet, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxActionSheet, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxActionSheet, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxActionSheetOptions; } /** * @deprecated Use Item instead * @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 dxActionSheetItem extends CollectionWidgetItem { /** * Specifies the icon to be displayed on the action sheet button. */ icon?: string; /** * A handler for the click event raised for the button representing the given action sheet button. */ onClick?: | (( e: DevExpress.common.core.events.NativeEventInfo< dxActionSheet, MouseEvent | PointerEvent > ) => void) | string; /** * Specifies the type of the button that is an action sheet item. */ type?: DevExpress.common.ButtonType | string; /** * Specifies which style to apply to the button that is an action sheet item. */ stylingMode?: DevExpress.common.ButtonStyle; } /** * * @deprecated */ export interface dxActionSheetOptions< TItem extends DevExpress.ui.dxActionSheet.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * The text displayed in the button that closes the action sheet. */ cancelText?: string; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * An array of items displayed by the UI component. */ items?: Array; /** * A function that is executed when the Cancel button is clicked or tapped. */ onCancelClick?: | ((e: DevExpress.ui.dxActionSheet.CancelClickEvent) => void) | string; /** * Specifies whether or not to display the Cancel button in action sheet. */ showCancelButton?: boolean; /** * A Boolean value specifying whether or not the title of the action sheet is visible. */ showTitle?: boolean; /** * Specifies the element the action sheet popover points at. Applies only if usePopover is true. */ target?: string | DevExpress.core.UserDefinedElement; /** * The title of the action sheet. */ title?: string; /** * Specifies whether or not to show the action sheet within a Popover UI component. */ usePopover?: boolean; /** * A Boolean value specifying whether or not the ActionSheet UI component is visible. */ visible?: boolean; } /** * The AutoComplete UI component is a textbox that provides suggestions while a user types into it. */ export class dxAutocomplete extends dxDropDownList { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxAutocomplete.Properties['value']): void; } module dxAutocomplete { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, UIEvent & { target: HTMLInputElement } >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, ClipboardEvent >; export type Properties = dxAutocompleteOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxDropDownList.SelectionChangedInfo; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxAutocomplete, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxAutocompleteOptions extends dxDropDownListOptions { /** * Specifies the maximum count of items displayed by the UI component. */ maxItemCount?: number; /** * The minimum number of characters that must be entered into the text box to begin a search. */ minSearchLength?: number; /** * Specifies whether the drop-down button is visible. */ showDropDownButton?: boolean; /** * Specifies the current value displayed by the UI component. */ value?: string | null; /** * Configures the drop-down field which holds the content. */ dropDownOptions?: DevExpress.ui.dxPopup.Properties; } /** * The Box UI component allows you to arrange various elements within it. Separate and adaptive, the Box UI component acts as a building block for the layout. */ export class dxBox< TItem extends DevExpress.ui.dxBox.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> {} module dxBox { export type BoxDirection = 'col' | 'row'; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type CrosswiseDistribution = 'center' | 'end' | 'start' | 'stretch'; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type Distribution = | 'center' | 'end' | 'space-around' | 'space-between' | 'start'; export type ExplicitTypes, TKey> = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxBox, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxBox, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxBox, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxBoxOptions; } /** * @deprecated Use Item instead * @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 dxBoxItem extends CollectionWidgetItem { /** * Specifies the base size of an item element along the main direction. */ baseSize?: number | string; /** * Holds a Box configuration object for the item. */ box?: dxBoxOptions | undefined; /** * Specifies the ratio value used to count the item element size along the main direction. */ ratio?: number; /** * A factor that defines how much an item shrinks relative to the rest of the items in the container. */ shrink?: number; } /** * * @deprecated */ export interface dxBoxOptions< TItem extends DevExpress.ui.dxBox.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Specifies how UI component items are aligned along the main direction. */ align?: DevExpress.ui.dxBox.Distribution; /** * Specifies how UI component items are aligned cross-wise. */ crossAlign?: DevExpress.ui.dxBox.CrosswiseDistribution; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the direction of item positioning in the UI component. */ direction?: DevExpress.ui.dxBox.BoxDirection; /** * An array of items displayed by the UI component. */ items?: Array; } /** * The Button UI component is a simple button that performs specified commands when a user clicks it. */ export class dxButton extends Widget {} module dxButton { /** * The type of the click event handler's argument. */ export type ClickEvent = DevExpress.common.core.events.NativeEventInfo< dxButton, KeyboardEvent | MouseEvent | PointerEvent > & { /** * */ validationGroup?: any; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxButtonOptions; export type TemplateData = { readonly text?: string; readonly icon?: string; }; } /** * The ButtonGroup is a UI component that contains a set of toggle buttons and can be used as a mode switcher. */ export class dxButtonGroup extends Widget {} module dxButtonGroup { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxButtonGroup, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxButtonGroupOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.CollectionWidget.SelectionChangeInfo; } /** * @deprecated Use Item instead * @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 dxButtonGroupItem extends CollectionWidgetItem { /** * Specifies a text for the hint that appears when the button is hovered over or long-pressed. */ hint?: string; /** * Specifies the icon to be displayed on the button. */ icon?: string; /** * Specifies the button type. */ type?: DevExpress.common.ButtonType | string; /** * Specifies the global attributes to be attached to the button group item's container element. */ elementAttr?: { [key: string]: any }; } /** * * @deprecated * @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 dxButtonGroupOptions extends WidgetOptions { /** * Specifies a template for all the buttons in the group. */ buttonTemplate?: | template | (( buttonData: any, buttonContent: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * */ focusStateEnabled?: boolean; /** * */ hoverStateEnabled?: boolean; /** * Configures buttons in the group. */ items?: Array; /** * Specifies which data field provides keys used to distinguish between the selected buttons. */ keyExpr?: string | Function; /** * A function that is executed when a button is clicked or tapped. */ onItemClick?: (e: DevExpress.ui.dxButtonGroup.ItemClickEvent) => void; /** * A function that is executed when a button is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.ui.dxButtonGroup.SelectionChangedEvent ) => void; /** * Contains keys of selected buttons and allows you to specify initial button selection state. */ selectedItemKeys?: Array; /** * Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array. */ selectedItems?: Array; /** * Specifies the button selection mode. */ selectionMode?: DevExpress.common.SingleMultipleOrNone; /** * Specifies how buttons in the group are styled. */ stylingMode?: DevExpress.common.ButtonStyle; } /** * * @deprecated * @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 dxButtonOptions extends WidgetOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the icon to be displayed on the button. */ icon?: string; /** * A function that is executed when the Button is clicked or tapped. */ onClick?: (e: DevExpress.ui.dxButton.ClickEvent) => void; /** * Specifies how the button is styled. */ stylingMode?: DevExpress.common.ButtonStyle; /** * Specifies a custom template for the Button UI component. */ template?: | template | (( data: DevExpress.ui.dxButton.TemplateData, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * The text displayed on the button. */ text?: string; /** * Specifies the button type. */ type?: DevExpress.common.ButtonType | string; /** * Specifies whether the button submits an HTML form. */ useSubmitBehavior?: boolean; /** * Specifies the name of the validation group to be accessed in the click event handler. */ validationGroup?: string | undefined; } /** * The Calendar is a UI component that displays a calendar and allows an end user to select the required date within a specified date range. */ export class dxCalendar extends Editor { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxCalendar.Properties['value']): void; } module dxCalendar { export type CalendarSelectionMode = 'single' | 'multiple' | 'range'; export type CalendarZoomLevel = 'century' | 'decade' | 'month' | 'year'; export type CellTemplateData = { readonly date?: Date; readonly view: string; readonly 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 interface ComponentDisabledDate { component: T; readonly date: Date; readonly view: string; } export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * Specifies dates that users cannot select. */ export type DisabledDate = ComponentDisabledDate; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxCalendarOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxCalendar, DevExpress.events.InteractionEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; export type WeekNumberRule = | 'auto' | 'firstDay' | 'fullWeek' | 'firstFourDays'; } /** * * @deprecated * @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 dxCalendarOptions extends EditorOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies a custom template for calendar cells. */ cellTemplate?: | template | (( itemData: DevExpress.ui.dxCalendar.CellTemplateData, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the date-time value serialization format. */ dateSerializationFormat?: string | undefined; /** * Specifies dates that users cannot select. */ disabledDates?: | Array | ((data: DevExpress.ui.dxCalendar.DisabledDate) => boolean); /** * Specifies the first day of a week. */ firstDayOfWeek?: DevExpress.common.FirstDayOfWeek | undefined; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * The latest date the UI component allows to select. */ max?: DevExpress.common.DateLike; /** * Specifies the maximum zoom level of the calendar. */ maxZoomLevel?: DevExpress.ui.dxCalendar.CalendarZoomLevel; /** * The earliest date the UI component allows to select. */ min?: DevExpress.common.DateLike; /** * Specifies the minimum zoom level of the calendar. */ minZoomLevel?: DevExpress.ui.dxCalendar.CalendarZoomLevel; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies one of three selection modes: single, multiple, or range. */ selectionMode?: DevExpress.ui.dxCalendar.CalendarSelectionMode; /** * Specifies whether a user can select a week by clicking on a week number. */ selectWeekOnClick?: boolean; /** * Specifies whether or not the UI component displays a button that selects the current date. */ showTodayButton?: boolean; /** * Specifies whether to display a column with week numbers. */ showWeekNumbers?: boolean; /** * Specifies a week number calculation rule. */ weekNumberRule?: DevExpress.ui.dxCalendar.WeekNumberRule; /** * An object or a value that specifies the date and time selected in the calendar. */ value?: DevExpress.common.DateLike | DevExpress.common.DateLike[]; /** * Specifies the current calendar zoom level. */ zoomLevel?: DevExpress.ui.dxCalendar.CalendarZoomLevel; } /** * CardView is a UI component that uses a 'card' layout to present information. */ export class dxCardView< TCardData = unknown, TKey = unknown > extends Widget { /** * Gets the container of a card with a specific index. */ getCardElement(cardIndex: number): DevExpress.core.DxElement; /** * Gets currently rendered cards. */ getVisibleCards(): DevExpress.ui.dxCardView.CardInfo[]; /** * Gets the index of a card with a specific key. */ getCardIndexByKey(key: TKey): number; /** * Gets the key of a card with a specific index. */ getKeyByCardIndex(cardIndex: number): TKey; /** * Gets the instance of the UI component's scrollable part. */ getScrollable(): dxScrollable; /** * Displays the load panel. */ beginCustomLoading(text?: string): void; /** * Hides the load panel. */ endCustomLoading(): void; /** * Clears sorting settings of all columns. */ clearSorting(): void; /** * Gets the total filter that combines all the filters applied. */ getCombinedFilter(): any; /** * Clears all filters applied to UI component cards. */ clearFilter(): void; /** * Hides the column chooser. */ hideColumnChooser(): void; /** * Shows the column chooser. */ showColumnChooser(): void; /** * Searches for a string in columns whose allowSearch property is `true`. */ searchByText(text: string): void; /** * Adds an empty card and switches it to the editing state. */ addCard(): void; /** * Discards changes that a user made to data. */ cancelEditData(): void; /** * Removes a card with a specific index. */ deleteCard(cardIndex: number): void; /** * Switches a card with a specific index to the editing state. */ editCard(cardIndex: number): void; /** * Checks whether the UI component has unsaved changes. */ hasEditData(): void; /** * Saves changes that a user made to data. */ saveEditData(): void; /** * Gets a data object with a specific key. */ byKey(key: TKey): TCardData; /** * Gets the DataSource instance. */ getDataSource(): DevExpress.common.data.DataSource; /** * Gets a data item's key value. */ keyOf(obj: TCardData): TKey; /** * Gets the total page count. */ pageCount(): number; /** * Gets the current page index. */ pageIndex(): number; /** * Switches the UI component to a specific page using a zero-based index. */ pageIndex(value: number): void; /** * Gets the current page size. */ pageSize(): number; /** * Sets the page size. */ pageSize(value: number): void; /** * Gets the total card count. */ totalCount(): number; /** * Selects cards with specific keys. */ selectCards(keys: Array, preserve: boolean): void; /** * Cancels the selection of cards with specific keys. */ deselectCards(keys: Array): void; /** * Selects all cards. */ selectAll(): void; /** * Clears the selection of all cards on all pages or the currently rendered page only. */ deselectAll(): void; /** * Clears selection of all cards on all pages. */ clearSelection(): void; /** * Gets the selected cards' data objects. */ getSelectedCardsData(): Array; /** * Gets the selected card keys. */ getSelectedCardKeys(): Array; /** * Checks whether a card with a specific key is selected. */ isCardSelected(key: TKey): boolean; } module dxCardView { /** * The argument type in the cardClick event. */ export type CardClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithCardInfo; /** * The argument type in the cardDblClick event. */ export type CardDblClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithCardInfo; export type CardHeaderPredefinedItem = | 'selectionCheckBox' | 'updateButton' | 'deleteButton'; /** * The argument type in the cardHoverChanged event. */ export type CardHoverChangedEvent = DevExpress.common.core.events.EventInfo & WithCardInfo & { /** * Indicates whether the pointer entered or left the card. Can be either 'mouseover' or 'mouseout'. */ eventType: string; }; /** * The argument type in the cardInserted event. */ export type CardInsertedEvent = DevExpress.common.core.events.EventInfo & { /** * The data of the card. */ data: DevExpress.core.DeepPartial; }; /** * The argument type in the cardInserting event. */ export type CardInsertingEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * The data of the card. */ data: DevExpress.core.DeepPartial; }; /** * The argument type in the cardPrepared event. */ export type CardPreparedEvent = DevExpress.common.core.events.EventInfo & WithCardInfo; /** * The argument type in the cardRemoved event. */ export type CardRemovedEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & { /** * The data of the card. */ data: TCardData; /** * The card's key. */ key: TKey; }; /** * The argument type in the cardRemoving event. */ export type CardRemovingEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * The data of the card. */ data: TCardData; /** * The card's key. */ key: TKey; }; /** * The argument type in the cardSaved event. */ export type CardSavedEvent = DevExpress.common.core.events.EventInfo & { /** * All card data (including changes). Differs from onCardSaving, which only consists of pending changes. */ changes: DevExpress.common.grids.DataChange[]; }; /** * The argument type in the cardSaving event. */ export type CardSavingEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * Assign a Promise to this field to perform an asynchronous operation, such as a request to a server. */ promise?: PromiseLike; /** * Pending row changes; a copy of the editing.changes array. Includes only card changes, unlike onCardSaved, which contains all card data (including changes). */ changes: DevExpress.common.grids.DataChange[]; }; /** * Specifies card template data. */ export type CardTemplateData = { card: CardInfo; }; /** * The argument type in the cardUpdated event. */ export type CardUpdatedEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & { /** * The updated data of the card. */ data: TCardData; /** * The card's key. */ key: TKey; }; /** * The argument type in the cardUpdating event. */ export type CardUpdatingEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * The card's key. */ key: TKey; /** * The card's old data. */ oldData: TCardData; /** * The card's updated data. */ newData: DevExpress.core.DeepPartial; }; /** * The data of column template. */ export type ColumnTemplateData = { column: Column; }; /** * The argument type in the contextMenuPreparing event. */ export type ContextMenuPreparingEvent = DevExpress.common.core.events.EventInfo & { /** * Items to be displayed in the context menu. */ items?: any[]; /** * The name of the element on which the context menu is invoked: 'headerPanel', 'content', or 'toolbar'. */ readonly target: ContextMenuTarget; /** * The target element's container. */ readonly targetElement: DevExpress.core.DxElement; /** * The index of the column on which the context menu is invoked. */ readonly columnIndex?: number; /** * The column's configuration. */ readonly column?: Column; /** * The index of the card on which the context menu is invoked. */ readonly cardIndex?: number; /** * The card properties. */ readonly card?: TCardData; }; export type ContextMenuTarget = 'toolbar' | 'headerPanel' | 'content'; /** * The argument type in the editCanceled event. */ export type EditCanceledEvent = DevExpress.common.core.events.EventInfo & { /** * Discarded card changes. */ changes: DevExpress.common.grids.DataChange[]; }; /** * The argument type in the editCanceling event. */ export type EditCancelingEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * Card changes to be discarded. */ changes: DevExpress.common.grids.DataChange[]; }; /** * Configures editing. */ export type Editing = { /** * Specifies whether a user can add new cards. */ allowAdding?: boolean; /** * Specifies whether a user can delete cards. */ allowDeleting?: boolean; /** * Specifies whether a user can update cards. */ allowUpdating?: boolean; /** * An array of pending row changes. */ changes?: DevExpress.common.grids.DataChange[]; /** * Specifies if confirmation is required when a user deletes a row. */ confirmDelete?: boolean; /** * The key(s) of a card being edited. */ editCardKey?: TKey | null; /** * Configures the form inside the editing popup. */ form?: DevExpress.ui.dxForm.Properties; /** * Configures the editing popup. */ popup?: DevExpress.ui.dxPopup.Properties; /** * */ texts?: EditingTexts; }; /** * The argument type in the editingStart event. */ export type EditingStartEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.Cancelable & { /** * The data of a card to be edited. */ data: TCardData; /** * The card's key. */ key: TKey; }; export type ExplicitTypes = { Properties: Properties; }; /** * The argument type in the fieldCaptionClick event. */ export type FieldCaptionClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithFieldCaptionInfo; /** * The argument type in the fieldCaptionDblClick event. */ export type FieldCaptionDblClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithFieldCaptionInfo; /** * The argument type in the fieldCaptionPrepared event. */ export type FieldCaptionPreparedEvent = DevExpress.common.core.events.EventInfo & WithFieldCaptionInfo; /** * Specifies a custom template for the field. */ export type FieldTemplateData = { /** * Information about the field. */ field: FieldInfo; }; /** * The argument type in the fieldValueClick event. */ export type FieldValueClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithFieldValueInfo; /** * The argument type in the fieldValueDblClick event. */ export type FieldValueDblClickEvent = DevExpress.common.core.events.NativeEventInfo< dxCardView, DevExpress.events.PointerInteractionEvent > & WithFieldValueInfo; /** * The argument type in the fieldValuePrepared event. */ export type FieldValuePreparedEvent = DevExpress.common.core.events.EventInfo & WithFieldValueInfo; /** * The argument type in the focusedCardChanged event. */ export type FocusedCardChanged = DevExpress.common.core.events.EventInfo & WithCardInfo; /** * The argument type in the initNewCard event. */ export type InitNewCardEvent = DevExpress.common.core.events.EventInfo & { /** * The data of the inserted card; initially empty. */ data: DevExpress.core.DeepPartial; /** * Assign a Promise to this field to perform an asynchronous operation, such as a request to the server. */ promise?: PromiseLike; }; export type PredefinedToolbarItem = | 'columnChooserButton' | 'searchPanel' | 'addCardButton' | 'selectAllButton' | 'clearSelectionButton'; export type Properties< TCardData = unknown, TKey = unknown > = dxCardViewOptions; /** * The argument type in the selectionChanged event. */ export type SelectionChangedEvent< TCardData = unknown, TKey = unknown > = DevExpress.common.core.events.EventInfo & { /** * The data of all selected cards. */ selectedCardsData: Array; /** * The keys of all selected cards. */ selectedCardKeys: Array; /** * The keys of the cards that were selected. */ currentSelectedCardKeys: Array; /** * The keys of the cards whose selection was cleared. */ currentDeselectedCardKeys: Array; }; /** * Configures runtime selection. */ export type SelectionConfiguration = { /** * Allows users to simultaneously select all or current page cards (depending on selectAllMode). */ allowSelectAll?: boolean; /** * Specifies the selection mode. */ mode?: DevExpress.common.SingleMultipleOrNone; /** * Specifies the mode for selecting cards. Applies only if selection.allowSelectAll is `true`. */ selectAllMode?: DevExpress.common.SelectAllMode; /** * Specifies when to display card selection checkboxes. */ showCheckBoxesMode?: DevExpress.common.grids.SelectionColumnDisplayMode; }; /** * * @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. */ type WithCardInfo = { /** * */ readonly card: CardInfo; /** * */ readonly cardElement: DevExpress.core.DxElement; }; /** * * @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. */ type WithFieldCaptionInfo = { /** * */ readonly field: FieldInfo; /** * */ readonly fieldCaptionElement: DevExpress.core.DxElement; }; /** * * @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. */ type WithFieldValueInfo = { /** * */ readonly field: FieldInfo; /** * */ readonly fieldValueElement: DevExpress.core.DxElement; }; } /** * @deprecated Use DevExpress.ui.dxCardView.Editing instead * @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 dxCardViewEditing< TCardData = unknown, TKey = unknown > = DevExpress.ui.dxCardView.Editing; /** * @deprecated Use DevExpress.ui.dxCardView.FieldInfo instead * @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 dxCardViewFieldInfo = DevExpress.ui.dxCardView.FieldInfo; /** * * @deprecated */ export interface dxCardViewOptions extends WidgetOptions { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike; /** * Configures paging. */ paging?: DevExpress.ui.dxCardView.Paging; /** * Specifies the key property (or properties) that supply key values to access data items. Each key value must be unique. This property applies only if data is a simple array. */ keyExpr?: string | string[]; /** * Notifies CardView of the server's data processing operations. */ remoteOperations?: | DevExpress.ui.dxCardView.RemoteOperations | boolean | DevExpress.common.Mode; /** * A function that is executed when an error occurs in the data source. */ onDataErrorOccurred?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.common.grids.DataErrorOccurredInfo ) => void; /** * Configures the pager. */ pager?: DevExpress.common.grids.Pager; /** * An array of CardView columns. */ columns?: ( | DevExpress.ui.dxCardView.ColumnProperties | string )[]; /** * Specifies whether a user can reorder columns. */ allowColumnReordering?: boolean; /** * Configures the header panel. */ headerPanel?: DevExpress.ui.dxCardView.HeaderPanel; /** * Configures scrolling. */ scrolling?: { /** * Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is `false`. */ scrollByContent?: boolean; /** * Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is `false`. */ scrollByThumb?: boolean; /** * Specifies when to display scroll bars. Applies only if useNative is `false`. */ showScrollbar?: DevExpress.common.ScrollbarMode; /** * Specifies whether CardView should use native or simulated scrolling. */ useNative?: boolean | DevExpress.common.Mode; }; /** * Indicates whether to show the error row. */ errorRowEnabled?: boolean; /** * Configures the load panel. */ loadPanel?: dxLoadPanelOptions; /** * Specifies a text string to display when no data appears in CardView. */ noDataText?: string; /** * Specifies a custom template to be displayed when no data appears in CardView. */ noDataTemplate?: | template | (( e: { text: string }, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the number of cards per row. */ cardsPerRow?: number | DevExpress.common.Mode; /** * Specifies the minimum width of the card. */ cardMinWidth?: number; /** * Specifies the maximum width of the card. */ cardMaxWidth?: number; /** * Specifies whether text that does not fit into a field should be wrapped. */ wordWrapEnabled?: boolean; /** * Configures the card cover. */ cardCover?: DevExpress.ui.dxCardView.CardCover; /** * Specifies a custom template for the card. */ cardTemplate?: | template | (( data: DevExpress.ui.dxCardView.CardTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for card content. */ cardContentTemplate?: | template | (( data: DevExpress.ui.dxCardView.CardTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Displays a hint when the mouse hovers over truncated field content. */ fieldHintEnabled?: boolean; /** * A function that is executed when a card is clicked or tapped. */ onCardClick?: (e: DevExpress.ui.dxCardView.CardClickEvent) => void; /** * A function that is executed when a card is double-clicked or double-tapped. */ onCardDblClick?: (e: DevExpress.ui.dxCardView.CardDblClickEvent) => void; /** * A function that is executed after a card is created. */ onCardPrepared?: (e: DevExpress.ui.dxCardView.CardPreparedEvent) => void; /** * A function that is executed when a field caption is clicked or tapped. */ onFieldCaptionClick?: ( e: DevExpress.ui.dxCardView.FieldCaptionClickEvent ) => void; /** * A function that is executed when a field caption is double-clicked or double-tapped. */ onFieldCaptionDblClick?: ( e: DevExpress.ui.dxCardView.FieldCaptionDblClickEvent ) => void; /** * A function that is executed after a field caption is created. */ onFieldCaptionPrepared?: ( e: DevExpress.ui.dxCardView.FieldCaptionPreparedEvent ) => void; /** * A function that is executed when a field value is clicked or tapped. */ onFieldValueClick?: ( e: DevExpress.ui.dxCardView.FieldValueClickEvent ) => void; /** * A function that is executed when a field value is double-clicked or double-tapped. */ onFieldValueDblClick?: ( e: DevExpress.ui.dxCardView.FieldValueDblClickEvent ) => void; /** * A function that is executed after a field value is created. */ onFieldValuePrepared?: ( e: DevExpress.ui.dxCardView.FieldValuePreparedEvent ) => void; /** * A function that is executed after the pointer enters or leaves a card. */ onCardHoverChanged?: ( e: DevExpress.ui.dxCardView.CardHoverChangedEvent ) => void; /** * Specifies a custom template for a card footer. */ cardFooterTemplate?: | template | (( data: DevExpress.ui.dxCardView.CardTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Configures the card header. */ cardHeader?: DevExpress.ui.dxCardView.CardHeader; /** * Specifies whether the UI component changes its appearance when a user hovers over it. */ hoverStateEnabled?: boolean; /** * Configures the toolbar. */ toolbar?: DevExpress.ui.dxCardView.Toolbar; /** * Configures sorting. */ sorting?: DevExpress.common.grids.Sorting; /** * Specifies a filter expression. */ filterValue?: string | Array | Function; /** * Configures the integrated filter builder popup. */ filterBuilderPopup?: DevExpress.ui.dxPopup.Properties; /** * Configures the filter builder. */ filterBuilder?: dxFilterBuilderOptions; /** * Configures the filter panel. */ filterPanel?: DevExpress.common.grids.FilterPanel; /** * Configures the column chooser. */ columnChooser?: DevExpress.common.grids.ColumnChooser; /** * Configures the search panel. */ searchPanel?: DevExpress.common.grids.SearchPanel; /** * Configures the header filter. */ headerFilter?: DevExpress.common.grids.HeaderFilter; /** * Configures editing. */ editing?: DevExpress.ui.dxCardView.Editing; /** * A function that is executed after card changes are discarded. */ onEditCanceled?: (e: DevExpress.ui.dxCardView.EditCanceledEvent) => void; /** * A function that is executed when the edit operation is canceled, but card changes are not yet discarded. */ onEditCanceling?: (e: DevExpress.ui.dxCardView.EditCancelingEvent) => void; /** * A function that is executed before a card switches to the editing state. */ onEditingStart?: (e: DevExpress.ui.dxCardView.EditingStartEvent) => void; /** * A function that is executed before a new card is added to the UI component. */ onInitNewCard?: ( e: DevExpress.ui.dxCardView.InitNewCardEvent ) => void; /** * A function that is executed after a new card is inserted into the data source. */ onCardInserted?: (e: DevExpress.ui.dxCardView.CardInsertedEvent) => void; /** * A function that is executed before a new card is inserted into the data source. */ onCardInserting?: (e: DevExpress.ui.dxCardView.CardInsertingEvent) => void; /** * A function that is executed after a card was removed from the data source. */ onCardRemoved?: (e: DevExpress.ui.dxCardView.CardRemovedEvent) => void; /** * A function that is executed before a card is removed from the data source. */ onCardRemoving?: (e: DevExpress.ui.dxCardView.CardRemovingEvent) => void; /** * A function that is executed after a card is updated in the data source. */ onCardUpdated?: (e: DevExpress.ui.dxCardView.CardUpdatedEvent) => void; /** * A function that is executed before a card is updated in the data source. */ onCardUpdating?: (e: DevExpress.ui.dxCardView.CardUpdatingEvent) => void; /** * A function that is executed after card changes are saved. */ onCardSaved?: (e: DevExpress.ui.dxCardView.CardSavedEvent) => void; /** * A function that is executed before pending card changes are saved. */ onCardSaving?: (e: DevExpress.ui.dxCardView.CardSavingEvent) => void; /** * Allows you to select cards or determine which cards are selected. */ selectedCardKeys?: Array; /** * Configures runtime selection. */ selection?: DevExpress.ui.dxCardView.SelectionConfiguration; /** * A function that is executed when a card is selected or its selection is cleared. */ onSelectionChanged?: ( e: DevExpress.ui.dxCardView.SelectionChangedEvent ) => void; /** * A function that is executed after the focused card changes. */ onFocusedCardChanged?: ( e: DevExpress.ui.dxCardView.FocusedCardChanged ) => void; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxCardView.ContextMenuPreparingEvent ) => void; } /** * @deprecated Use DevExpress.ui.dxCardView.Toolbar instead * @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 dxCardViewToolbar = DevExpress.ui.dxCardView.Toolbar; /** * @deprecated Use DevExpress.ui.dxCardView.ToolbarItem instead * @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 dxCardViewToolbarItem = DevExpress.ui.dxCardView.ToolbarItem; /** * The Chat UI component is an interactive interface that allows users to send and receive messages in real time. */ export class dxChat extends Widget { /** * Renders a new message. */ renderMessage(message: DevExpress.ui.dxChat.Message): void; getDataSource(): DevExpress.common.data.DataSource; } module dxChat { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type ExplicitTypes = { Properties: Properties; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The argument type in the messageDeleted event. */ export type MessageDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * The message that was deleted. */ readonly message: Message; }; /** * The argument type in the messageDeleting event. */ export type MessageDeletingEvent = DevExpress.common.core.events.AsyncCancelable & DevExpress.common.core.events.EventInfo & { /** * The message that is being deleted. */ readonly message: Message; }; /** * The argument type in the messageEditCanceled event. */ export type MessageEditCanceledEvent = DevExpress.common.core.events.EventInfo & { /** * The message which editing was canceled. */ readonly message: Message; }; /** * The argument type in the messageEditingStart event. */ export type MessageEditingStartEvent = DevExpress.common.core.events.AsyncCancelable & DevExpress.common.core.events.EventInfo & { /** * The message which editing started. */ readonly message: Message; }; /** * The argument type in the messageEntered event. */ export type MessageEnteredEvent = DevExpress.common.core.events.NativeEventInfo< dxChat, DevExpress.events.InteractionEvent > & { /** * The message that was entered into the chat. */ readonly message: Message; }; export type MessageTemplateData = { readonly component: dxChat; readonly message?: Message; }; /** * The argument type in the messageUpdated event. */ export type MessageUpdatedEvent = DevExpress.common.core.events.EventInfo & { /** * The message that was updated. */ readonly message: Message; /** * The updated text from the input field. */ readonly text: string; }; /** * The argument type in the messageUpdating event. */ export type MessageUpdatingEvent = DevExpress.common.core.events.AsyncCancelable & DevExpress.common.core.events.EventInfo & { /** * The message to be updated. */ readonly message: Message; /** * The updated text from the input field. */ readonly text: string; }; /** * The argument type in the optionChanged event. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxChatOptions; /** * The argument type in the typingEnd event. */ export type TypingEndEvent = DevExpress.common.core.events.EventInfo & { /** * The user who stopped typing. */ readonly user: User; }; /** * The argument type in the typingStart. */ export type TypingStartEvent = DevExpress.common.core.events.NativeEventInfo< dxChat, UIEvent & { target: HTMLInputElement } > & { /** * The user who started typing. */ readonly user?: User; }; } /** * * @deprecated */ export interface dxChatOptions extends WidgetOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the Chat's input element can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the current chat user (messages displayed on the right side). */ user?: DevExpress.ui.dxChat.User; /** * Specifies an array of chat messages. */ items?: Array; /** * Configures editing. */ editing?: { /** * Specifies whether a user can update messages. Called for each message when defined as a function. */ allowUpdating?: | boolean | ((options: { component?: dxChat; message?: DevExpress.ui.dxChat.Message; }) => boolean); /** * Specifies whether a user can delete messages. Called for each message when defined as a function. */ allowDeleting?: | boolean | ((options: { component?: dxChat; message?: DevExpress.ui.dxChat.Message; }) => boolean); }; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the day header format. */ dayHeaderFormat?: DevExpress.common.core.localization.Format; /** * Specifies whether the Chat UI component displays newly entered messages immediately. This property only applies if dataSource is used. */ reloadOnChange?: boolean; /** * A list of available alerts. */ alerts?: Array; /** * Specifies a custom template for a chat message. */ messageTemplate?: | template | null | (( data: DevExpress.ui.dxChat.MessageTemplateData, messageBubbleElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the message timestamp format. */ messageTimestampFormat?: DevExpress.common.core.localization.Format; /** * An array of users who are currently typing. */ typingUsers?: Array; /** * Specifies whether to show day headers. */ showDayHeaders?: boolean; /** * Specifies whether to show user names. */ showUserName?: boolean; /** * Specifies whether to show avatars. */ showAvatar?: boolean; /** * Specifies whether to show message time stamps. */ showMessageTimestamp?: boolean; /** * A function that is executed after a message is entered into the chat. */ onMessageEntered?: | ((e: DevExpress.ui.dxChat.MessageEnteredEvent) => void) | undefined; /** * A function that is called after a user starts typing. */ onTypingStart?: | ((e: DevExpress.ui.dxChat.TypingEndEvent) => void) | undefined; /** * A function that is called 2 seconds after a user stops typing or after a message is entered. */ onTypingEnd?: | ((e: DevExpress.ui.dxChat.TypingEndEvent) => void) | undefined; /** * A function that is executed before a message is removed from the UI. */ onMessageDeleting?: | ((e: DevExpress.ui.dxChat.MessageDeletingEvent) => void) | undefined; /** * A function that is executed after a message was removed from the UI. */ onMessageDeleted?: | ((e: DevExpress.ui.dxChat.MessageDeletedEvent) => void) | undefined; /** * A function that is executed before a message switches to the editing state. */ onMessageEditingStart?: | ((e: DevExpress.ui.dxChat.MessageEditingStartEvent) => void) | undefined; /** * A function that is executed after message changes are discarded. */ onMessageEditCanceled?: | ((e: DevExpress.ui.dxChat.MessageEditCanceledEvent) => void) | undefined; /** * A function that is executed before a message is edited in the UI. */ onMessageUpdating?: | ((e: DevExpress.ui.dxChat.MessageUpdatingEvent) => void) | undefined; /** * A function that is executed after a message was edited in the UI. */ onMessageUpdated?: | ((e: DevExpress.ui.dxChat.MessageUpdatedEvent) => void) | undefined; } /** * The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific property has been chosen. */ export class dxCheckBox extends Editor { /** * Removes focus from the check box. */ blur(): void; /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxCheckBox.Properties['value']): void; } module dxCheckBox { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxCheckBoxOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxCheckBox, DevExpress.events.InteractionEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxCheckBoxOptions extends EditorOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether users can set the CheckBox state to indeterminate. */ enableThreeStateBehavior?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the check box icon's width and height. */ iconSize?: number | string | undefined; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies the text displayed by the check box. */ text?: string; /** * Specifies the UI component state. */ value?: boolean | null | undefined; } /** * The ColorBox is a UI component that allows an end user to enter a color or pick it out from the drop-down editor. */ export class dxColorBox extends dxDropDownEditor { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxColorBox.Properties['value']): void; } module dxColorBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, ClipboardEvent >; export type Properties = dxColorBoxOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxColorBox, KeyboardEvent | MouseEvent | PointerEvent | UIEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxColorBoxOptions extends dxDropDownEditorOptions { /** * Specifies the text displayed on the button that applies changes and closes the drop-down editor. */ applyButtonText?: string; /** * Specifies the way an end user applies the selected value. */ applyValueMode?: DevExpress.common.ApplyValueMode; /** * Specifies the text displayed on the button that cancels changes and closes the drop-down editor. */ cancelButtonText?: string; /** * Specifies whether or not the UI component value includes the alpha channel component. */ editAlphaChannel?: boolean; /** * Specifies a custom template for the input field. Must contain the TextBox UI component. */ fieldTemplate?: | template | (( value: string, fieldElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the size of a step by which a handle is moved using a keyboard shortcut. */ keyStep?: number; /** * Specifies the currently selected value. */ value?: string | null; /** * Configures the drop-down field which holds the content. */ dropDownOptions?: DevExpress.ui.dxPopup.Properties; } /** * The ContextMenu UI component displays a single- or multi-level context menu. An end user invokes this menu by a right click or a long press. */ export class dxContextMenu extends dxMenuBase< dxContextMenuOptions, dxContextMenuItem, TKey > { /** * Hides the UI component. */ hide(): DevExpress.core.utils.DxPromise; /** * Shows the UI component. */ show(): DevExpress.core.utils.DxPromise; /** * Shows or hides the UI component depending on the argument. */ toggle(showing: boolean): DevExpress.core.utils.DxPromise; } module dxContextMenu { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo>; export type ContextSubmenuDirection = 'auto' | 'left' | 'right'; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; HiddenEvent: HiddenEvent; HidingEvent: HidingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; PositioningEvent: PositioningEvent; SelectionChangedEvent: SelectionChangedEvent; ShowingEvent: ShowingEvent; ShownEvent: ShownEvent; }; /** * The type of the hidden event handler's argument. */ export type HiddenEvent = DevExpress.common.core.events.EventInfo>; /** * The type of the hiding event handler's argument. */ export type HidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo>; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxContextMenu, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent = DevExpress.common.core.events.NativeEventInfo< dxContextMenu, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the positioning event handler's argument. */ export type PositioningEvent = DevExpress.common.core.events.NativeEventInfo< dxContextMenu, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly position: DevExpress.common.core.animation.PositionConfig; }; export type Properties = dxContextMenuOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; /** * The type of the showing event handler's argument. */ export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo>; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo>; } /** * @deprecated Use DevExpress.ui.dxContextMenu.Item instead * @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 dxContextMenuItem extends dxMenuBaseItem { /** * Specifies nested menu items. */ items?: Array; } /** * * @deprecated */ export interface dxContextMenuOptions extends dxMenuBaseOptions, dxContextMenuItem, TKey> { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike< DevExpress.ui.dxContextMenu.Item, TKey > | null; /** * Specifies whether to hide the UI component if a user clicks outside it. */ hideOnOutsideClick?: | boolean | (( event: DevExpress.events.DxEvent ) => boolean); /** * Holds an array of menu items. */ items?: Array; /** * A function that is executed after the ContextMenu is hidden. */ onHidden?: (e: DevExpress.ui.dxContextMenu.HiddenEvent) => void; /** * A function that is executed before the ContextMenu is hidden. */ onHiding?: (e: DevExpress.ui.dxContextMenu.HidingEvent) => void; /** * A function that is executed before the ContextMenu is positioned. */ onPositioning?: ( e: DevExpress.ui.dxContextMenu.PositioningEvent ) => void; /** * A function that is executed before the ContextMenu is shown. */ onShowing?: (e: DevExpress.ui.dxContextMenu.ShowingEvent) => void; /** * A function that is executed after the ContextMenu is shown. */ onShown?: (e: DevExpress.ui.dxContextMenu.ShownEvent) => void; /** * An object defining UI component positioning properties. */ position?: DevExpress.common.core.animation.PositionConfig; /** * Specifies properties used to display the UI component. */ showEvent?: | { /** * The delay in milliseconds after which the UI component is displayed. */ delay?: number | undefined; /** * Specifies the event names on which the UI component is shown. */ name?: string | undefined; } | string; /** * Specifies the direction at which submenus are displayed. */ submenuDirection?: DevExpress.ui.dxContextMenu.ContextSubmenuDirection; /** * The target element associated with the context menu. */ target?: string | DevExpress.core.UserDefinedElement | undefined; /** * A Boolean value specifying whether or not the UI component is visible. */ visible?: boolean; } /** * The DataGrid is a UI component that represents data from a local or remote source in the form of a grid. This UI component offers such basic features as sorting, grouping, filtering, as well as more advanced capabilities, like state storing, client-side exporting, master-detail interface, and many others. */ export class dxDataGrid extends Widget> implements DevExpress.common.grids.GridBase { /** * Adds a new column. */ addColumn( columnOptions: DevExpress.ui.dxDataGrid.Column | string ): void; /** * Adds an empty data row and switches it to the editing state. */ addRow(): DevExpress.core.utils.DxPromise; /** * Ungroups grid records. */ clearGrouping(): void; /** * Collapses master rows or groups of a specific level. */ collapseAll(groupIndex?: number): void; /** * Collapses a group or a master row with a specific key. */ collapseRow(key: TKey): DevExpress.core.utils.DxPromise; /** * Expands master rows or groups of a specific level. Does not apply if data is remote. */ expandAll(groupIndex?: number): void; /** * Expands a group or a master row with a specific key. */ expandRow(key: TKey): DevExpress.core.utils.DxPromise; /** * Gets the currently selected rows' keys. */ getSelectedRowKeys(): Array & DevExpress.core.utils.DxPromise>; /** * Gets the selected rows' data objects. */ getSelectedRowsData(): Array & DevExpress.core.utils.DxPromise>; /** * Gets the value of a total summary item. */ getTotalSummaryValue(summaryItemName: string): any; /** * Gets all visible columns. */ getVisibleColumns(): Array>; /** * Gets all visible columns at a specific hierarchical level of column headers. Use it to access banded columns. */ getVisibleColumns( headerLevel: number ): Array>; /** * Gets currently rendered rows. */ getVisibleRows(): Array>; /** * Checks whether a specific group or master row is expanded or collapsed. */ isRowExpanded(key: TKey): boolean; /** * Checks whether a row found using its data object is selected. Takes effect only if selection.deferred is true. */ isRowSelected(data: TRowData): boolean; isRowSelected(key: TKey): boolean; /** * Gets the total row count. */ totalCount(): number; beginCustomLoading(messageText: string): void; byKey(key: TKey): DevExpress.core.utils.DxPromise; cancelEditData(): void; cellValue(rowIndex: number, dataField: string): any; cellValue(rowIndex: number, dataField: string, value: any): void; cellValue(rowIndex: number, visibleColumnIndex: number): any; cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; clearFilter(): void; clearFilter(filterName: string): void; clearSelection(): void; clearSorting(): void; closeEditCell(): void; collapseAdaptiveDetailRow(): void; columnCount(): number; columnOption(id: number | string): any; columnOption(id: number | string, optionName: string): any; columnOption( id: number | string, optionName: string, optionValue: any ): void; columnOption(id: number | string, options: any): void; deleteColumn(id: number | string): void; deleteRow(rowIndex: number): void; deselectAll(): DevExpress.core.utils.DxPromise; deselectRows( keys: Array ): DevExpress.core.utils.DxPromise>; editCell(rowIndex: number, dataField: string): void; editCell(rowIndex: number, visibleColumnIndex: number): void; editRow(rowIndex: number): void; endCustomLoading(): void; expandAdaptiveDetailRow(key: TKey): void; filter(): any; filter(filterExpr: any): void; focus(): void; focus(element: DevExpress.core.UserDefinedElement): void; getCellElement( rowIndex: number, dataField: string ): DevExpress.core.DxElement | undefined; getCellElement( rowIndex: number, visibleColumnIndex: number ): DevExpress.core.DxElement | undefined; getCombinedFilter(): any; getCombinedFilter(returnDataField: boolean): any; getDataSource(): DevExpress.common.data.DataSource; getKeyByRowIndex(rowIndex: number): TKey | undefined; getRowElement( rowIndex: number ): DevExpress.core.UserDefinedElementsArray | undefined; getRowIndexByKey(key: TKey): number; getScrollable(): DevExpress.common.Scrollable; getVisibleColumnIndex(id: number | string): number; hasEditData(): boolean; hideColumnChooser(): void; isAdaptiveDetailRowExpanded(key: TKey): boolean; isRowFocused(key: TKey): boolean; keyOf(obj: TRowData): TKey; navigateToRow(key: TKey): DevExpress.core.utils.DxPromise; pageCount(): number; pageIndex(): number; pageIndex(newIndex: number): DevExpress.core.utils.DxPromise; pageSize(): number; pageSize(value: number): void; refresh(): DevExpress.core.utils.DxPromise; refresh(changesOnly: boolean): DevExpress.core.utils.DxPromise; repaintRows(rowIndexes: Array): void; saveEditData(): DevExpress.core.utils.DxPromise; searchByText(text: string): void; selectAll(): DevExpress.core.utils.DxPromise; selectRows( keys: Array, preserve: boolean ): DevExpress.core.utils.DxPromise>; selectRowsByIndexes( indexes: Array ): DevExpress.core.utils.DxPromise>; showColumnChooser(): void; state(): any; state(state: any): void; undeleteRow(rowIndex: number): void; updateDimensions(): void; } module dxDataGrid { /** * The type of the adaptiveDetailRowPreparing event handler's argument. */ export type AdaptiveDetailRowPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.AdaptiveDetailRowPreparingInfo; /** * The type of the cellClick event handler's argument. */ export type CellClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly value?: any; /** * */ readonly displayValue?: any; /** * */ readonly text: string; /** * */ readonly columnIndex: number; /** * */ readonly column: Column; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly row: Row; }; /** * The type of the cellDblClick event handler's argument. */ export type CellDblClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly value?: any; /** * */ readonly displayValue?: any; /** * */ readonly text: string; /** * */ readonly columnIndex: number; /** * */ readonly column: Column; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly row: Row; }; /** * The type of the cellHoverChanged event handler's argument. */ export type CellHoverChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly eventType: string; /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly value?: any; /** * */ readonly text: string; /** * */ readonly displayValue?: any; /** * */ readonly columnIndex: number; /** * */ readonly rowIndex: number; /** * */ readonly column: Column; /** * */ readonly rowType: string; /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly row: Row; }; /** * The type of the cellPrepared event handler's argument. */ export type CellPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly value?: any; /** * */ readonly displayValue?: any; /** * */ readonly text: string; /** * */ readonly columnIndex: number; /** * */ readonly column: Column; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly row: Row; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly watch?: Function; /** * */ readonly oldValue?: any; }; export type Column = dxDataGridColumn< TRowData, TKey >; /** * @deprecated Use Column instead * @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 ColumnBase = DevExpress.common.grids.ColumnBase; export type ColumnButton< TRowData = any, TKey = any > = dxDataGridColumnButton; /** * @deprecated Use ColumnButton instead * @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 ColumnButtonBase = DevExpress.common.grids.ColumnButtonBase; /** * */ export type ColumnButtonClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, PointerEvent | MouseEvent > & { /** * */ row?: Row; /** * */ column?: Column; }; export type ColumnButtonTemplateData = { readonly component: dxDataGrid; readonly data?: TRowData; readonly key?: TKey; readonly columnIndex: number; readonly column: Column; readonly rowIndex: number; readonly rowType: string; readonly row: Row; }; export type ColumnCellTemplateData = { readonly data?: TRowData; readonly component: dxDataGrid; readonly value?: any; readonly oldValue?: any; readonly displayValue?: any; readonly text: string; readonly columnIndex: number; readonly rowIndex: number; readonly column: Column; readonly row: Row; readonly rowType: string; readonly watch?: Function; }; export type ColumnEditCellTemplateData = { readonly setValue?: any; readonly data?: TRowData; readonly component: dxDataGrid; readonly value?: any; readonly displayValue?: any; readonly text: string; readonly columnIndex: number; readonly rowIndex: number; readonly column: Column; readonly row: Row; readonly rowType: string; readonly watch?: Function; }; export type ColumnGroupCellTemplateData = { readonly data?: GroupData; readonly component: dxDataGrid; readonly value?: any; readonly text: string; readonly displayValue?: any; readonly columnIndex: number; readonly rowIndex: number; readonly column: Column; readonly row: Row, GroupKey>; readonly summaryItems: Array; readonly groupContinuesMessage?: string; readonly groupContinuedMessage?: string; }; export type ColumnHeaderCellTemplateData = { readonly component: dxDataGrid; readonly columnIndex: number; readonly column: Column; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the contextMenuPreparing event handler's argument. */ export type ContextMenuPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ items?: Array; /** * */ readonly target: DevExpress.common.grids.GridsContextMenuTarget; /** * */ readonly targetElement: DevExpress.core.DxElement; /** * */ readonly columnIndex: number; /** * */ readonly column?: Column; /** * */ readonly rowIndex: number; /** * */ readonly row?: Row; }; export type CustomSummaryInfo = { readonly component: dxDataGrid; readonly name?: string; readonly summaryProcess: string; readonly value?: any; totalValue?: any; readonly groupIndex?: number; }; /** * The type of the dataErrorOccurred event handler's argument. */ export type DataErrorOccurredEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataErrorOccurredInfo; export type DataGridCommandColumnType = | 'adaptive' | 'buttons' | 'detailExpand' | 'groupExpand' | 'selection' | 'drag'; export type DataGridExportFormat = 'pdf' | 'xlsx'; export type DataGridPredefinedColumnButton = | 'cancel' | 'delete' | 'edit' | 'save' | 'undelete'; export type DataGridPredefinedToolbarItem = | 'addRowButton' | 'applyFilterButton' | 'columnChooserButton' | 'exportButton' | 'groupPanel' | 'revertButton' | 'saveButton' | 'searchPanel'; export type DataGridScrollMode = 'infinite' | 'standard' | 'virtual'; export type DataRowTemplateData = { readonly key: TKey; readonly data: TRowData; readonly component: dxDataGrid; readonly values: Array; readonly rowIndex: number; readonly columns: Array>; readonly isSelected?: boolean; readonly isExpanded?: boolean; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * @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 dxDataGridToolbar = Toolbar; /** * @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 dxDataGridToolbarItem = ToolbarItem; /** * The type of the editCanceled event handler's argument. */ export type EditCanceledEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * The type of the editCanceling event handler's argument. */ export type EditCancelingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * Configures editing. */ export type Editing = EditingBase< TRowData, TKey > & { /** * Specifies whether a user can add new rows. */ allowAdding?: boolean; /** * Specifies whether a user can delete rows. It is called for each data row when defined as a function. */ allowDeleting?: | boolean | ((options: { component?: dxDataGrid; row?: Row; }) => boolean); /** * Specifies whether a user can update rows. It is called for each data row when defined as a function. */ allowUpdating?: | boolean | ((options: { component?: dxDataGrid; row?: Row; }) => boolean); /** * Contains properties that specify texts for editing-related UI elements. */ texts?: any; /** * Specifies a position for a new row. */ newRowPosition?: DevExpress.common.grids.NewRowPosition; }; /** * @deprecated Use Editing instead * @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 EditingBase< TRowData = any, TKey = any > = DevExpress.common.grids.EditingBase; /** * The type of the editingStart event handler's argument. */ export type EditingStartEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly column?: Column; }; export type EditingTexts = DevExpress.common.grids.EditingTextsBase; /** * The type of the editorPrepared event handler's argument. */ export type EditorPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly parentType: string; /** * */ readonly value?: any; /** * */ readonly setValue?: any; /** * */ readonly updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; /** * */ readonly editorElement: DevExpress.core.DxElement; /** * */ readonly readOnly: boolean; /** * */ readonly dataField?: string; /** * */ readonly row?: Row; }; /** * The type of the editorPreparing event handler's argument. */ export type EditorPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly parentType: string; /** * */ readonly value?: any; /** * */ readonly setValue?: any; /** * */ readonly updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; /** * */ cancel: boolean; /** * */ readonly editorElement: DevExpress.core.DxElement; /** * */ readonly readOnly: boolean; /** * */ editorName: string; /** * */ editorOptions: any; /** * */ readonly dataField?: string; /** * */ readonly row?: Row; }; export type ExplicitTypes = { AdaptiveDetailRowPreparingEvent: AdaptiveDetailRowPreparingEvent< TRowData, TKey >; CellClickEvent: CellClickEvent; CellDblClickEvent: CellDblClickEvent; CellHoverChangedEvent: CellHoverChangedEvent; CellPreparedEvent: CellPreparedEvent; Column: Column; ColumnButton: ColumnButton; ColumnButtonClickEvent: ColumnButtonClickEvent; ColumnButtonTemplateData: ColumnButtonTemplateData; ColumnCellTemplateData: ColumnCellTemplateData; ColumnEditCellTemplateData: ColumnEditCellTemplateData; ColumnGroupCellTemplateData: ColumnGroupCellTemplateData; ColumnHeaderCellTemplateData: ColumnHeaderCellTemplateData< TRowData, TKey >; ContentReadyEvent: ContentReadyEvent; ContextMenuPreparingEvent: ContextMenuPreparingEvent; CustomSummaryInfo: CustomSummaryInfo; DataErrorOccurredEvent: DataErrorOccurredEvent; DataRowTemplateData: DataRowTemplateData; DisposingEvent: DisposingEvent; EditCanceledEvent: EditCanceledEvent; EditCancelingEvent: EditCancelingEvent; Editing: Editing; EditingStartEvent: EditingStartEvent; EditorPreparedEvent: EditorPreparedEvent; EditorPreparingEvent: EditorPreparingEvent; Export: Export; ExportingEvent: ExportingEvent; ExportTexts: ExportTexts; FocusedCellChangedEvent: FocusedCellChangedEvent; FocusedCellChangingEvent: FocusedCellChangingEvent; FocusedRowChangedEvent: FocusedRowChangedEvent; FocusedRowChangingEvent: FocusedRowChangingEvent; GroupData: GroupData; Grouping: Grouping; GroupingTexts: GroupingTexts; GroupPanel: GroupPanel; InitializedEvent: InitializedEvent; InitNewRowEvent: InitNewRowEvent; KeyDownEvent: KeyDownEvent; MasterDetail: MasterDetail; MasterDetailTemplateData: MasterDetailTemplateData; OptionChangedEvent: OptionChangedEvent; Properties: Properties; Row: Row; RowClickEvent: RowClickEvent; RowCollapsedEvent: RowCollapsedEvent; RowCollapsingEvent: RowCollapsingEvent; RowDblClickEvent: RowDblClickEvent; RowDraggingAddEvent: RowDraggingAddEvent; RowDraggingChangeEvent: RowDraggingChangeEvent; RowDraggingEndEvent: RowDraggingEndEvent; RowDraggingMoveEvent: RowDraggingMoveEvent; RowDraggingRemoveEvent: RowDraggingRemoveEvent; RowDraggingReorderEvent: RowDraggingReorderEvent; RowDraggingStartEvent: RowDraggingStartEvent; RowDraggingTemplateData: DevExpress.common.grids.RowDraggingTemplateData; RowExpandedEvent: RowExpandedEvent; RowExpandingEvent: RowExpandingEvent; RowInsertedEvent: RowInsertedEvent; RowInsertingEvent: RowInsertingEvent; RowPreparedEvent: RowPreparedEvent; RowRemovedEvent: RowRemovedEvent; RowRemovingEvent: RowRemovingEvent; RowTemplateData: RowTemplateData; RowUpdatedEvent: RowUpdatedEvent; RowUpdatingEvent: RowUpdatingEvent; RowValidatingEvent: RowValidatingEvent; SavedEvent: SavedEvent; SavingEvent: SavingEvent; Scrolling: Scrolling; Selection: Selection; SelectionChangedEvent: SelectionChangedEvent; Summary: Summary; SummaryGroupItem: SummaryGroupItem; SummaryItemTextInfo: SummaryItemTextInfo; SummaryTexts: SummaryTexts; SummaryTotalItem: SummaryTotalItem; Toolbar: Toolbar; ToolbarItem: ToolbarItem; ToolbarPreparingEvent: ToolbarPreparingEvent; }; /** * Configures client-side exporting. */ export type Export = { /** * Allows users to export selected rows only. */ allowExportSelectedData?: boolean; /** * Adds the Export button to the DataGrid's toolbar. */ enabled?: boolean; /** * Specifies the availability and captions of data export buttons. */ formats?: ('xlsx' | 'pdf' | string)[]; /** * Configures the texts of export commands, buttons, and hints. */ texts?: ExportTexts; }; /** * The type of the exporting event handler's argument. */ export type ExportingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & { /** * */ fileName?: string; /** * */ selectedRowsOnly: boolean; /** * */ format: DataGridExportFormat | string; }; /** * Configures the texts of export commands, buttons, and hints. */ export type ExportTexts = { /** * The text or hint of the command that exports all data. */ exportAll?: string; /** * The text of the command that exports selected rows. Applies when the allowExportSelectedData property is true. */ exportSelectedRows?: string; /** * The hint of the Export button when the allowExportSelectedData property is true. */ exportTo?: string; }; export type FilterPanel< TRowData = any, TKey = any > = DevExpress.common.grids.FilterPanel; export type FilterPanelCustomizeTextArg = DevExpress.common.grids.FilterPanelCustomizeTextArg; /** * The type of the focusedCellChanged event handler's argument. */ export type FocusedCellChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly columnIndex: number; /** * */ readonly rowIndex: number; /** * */ readonly row?: Row; /** * */ readonly column?: Column; }; /** * The type of the focusedCellChanging event handler's argument. */ export type FocusedCellChangingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxDataGrid, DevExpress.events.InteractionEvent > & { /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly prevColumnIndex: number; /** * */ readonly prevRowIndex: number; /** * */ newColumnIndex: number; /** * */ newRowIndex: number; /** * */ readonly rows: Array>; /** * */ readonly columns: Array>; /** * */ isHighlighted: boolean; }; /** * The type of the focusedRowChanged event handler's argument. */ export type FocusedRowChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly rowIndex: number; /** * */ readonly row?: Row; }; /** * The type of the focusedRowChanging event handler's argument. */ export type FocusedRowChangingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxDataGrid, DevExpress.events.InteractionEvent > & { /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly prevRowIndex: number; /** * */ newRowIndex: number; /** * */ readonly rows: Array>; }; /** * Specifies a group of elements in a template. */ export type GroupData = { key: any; items: Array | Array> | null; /** * @deprecated Attention! This property is for internal purposes only. */ collapsedItems?: Array | Array>; /** * @deprecated Attention! This property is for internal purposes only. */ aggregates?: Array; /** * @deprecated Attention! This property is for internal purposes only. */ summary?: Array; /** * @deprecated Attention! This property is for internal purposes only. */ isContinuation?: boolean; /** * @deprecated Attention! This property is for internal purposes only. */ isContinuationOnNextPage?: boolean; }; /** * Configures grouping. */ export type Grouping = { /** * Specifies whether the user can collapse grouped records in a grid or not. */ allowCollapsing?: boolean; /** * Specifies whether groups appear expanded or not. */ autoExpandAll?: boolean; /** * Enables the user to group data using the context menu. */ contextMenuEnabled?: boolean; /** * Specifies the event on which a group will be expanded/collapsed. */ expandMode?: DevExpress.common.grids.GroupExpandMode; /** * Defines the texts of grouping-related visual elements. */ texts?: GroupingTexts; }; /** * Defines the texts of grouping-related visual elements. */ export type GroupingTexts = { /** * Specifies the text of the context menu item that groups data by a specific column. */ groupByThisColumn?: string; /** * Specifies the message displayed in a group row when the corresponding group is continued from the previous page. */ groupContinuedMessage?: string; /** * Specifies the message displayed in a group row when the corresponding group continues on the next page. */ groupContinuesMessage?: string; /** * Specifies the text of the context menu item that clears grouping settings of a specific column. */ ungroup?: string; /** * Specifies the text of the context menu item that clears grouping settings of all columns. */ ungroupAll?: 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. */ type GroupKey = any[]; /** * Configures the group panel. */ export type GroupPanel = { /** * Specifies whether columns can be dragged onto or from the group panel. */ allowColumnDragging?: boolean; /** * Specifies text displayed by the group panel when it does not contain any columns. */ emptyPanelText?: string; /** * Specifies whether the group panel is visible or not. */ visible?: boolean | DevExpress.common.Mode; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxDataGrid >; /** * The type of the initNewRow event handler's argument. */ export type InitNewRowEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.NewRowInfo; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, KeyboardEvent > & DevExpress.common.grids.KeyDownInfo; /** * Allows you to build a master-detail interface in the grid. */ export type MasterDetail = { /** * Specifies whether detail sections appear expanded or collapsed. */ autoExpandAll?: boolean; /** * Enables an end-user to expand/collapse detail sections. */ enabled?: boolean; /** * Specifies a custom template for detail sections. */ template?: | template | (( detailElement: DevExpress.core.DxElement, detailInfo: MasterDetailTemplateData ) => any); }; export type MasterDetailTemplateData = { readonly key: TKey; readonly data: TRowData; readonly watch?: Function; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & 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. */ type OverriddenKeys = | 'columns' | 'customizeColumns' | 'dataRowTemplate' | 'editing' | 'export' | 'grouping' | 'groupPanel' | 'keyExpr' | 'masterDetail' | 'onCellClick' | 'onCellDblClick' | 'onCellHoverChanged' | 'onCellPrepared' | 'onContextMenuPreparing' | 'onEditingStart' | 'onEditorPrepared' | 'onEditorPreparing' | 'onExporting' | 'onFocusedCellChanged' | 'onFocusedCellChanging' | 'onFocusedRowChanged' | 'onFocusedRowChanging' | 'onRowClick' | 'onRowDblClick' | 'onRowPrepared' | 'remoteOperations' | 'rowTemplate' | 'scrolling' | 'selection' | 'selectionFilter' | 'sortByGroupSummaryInfo' | 'summary' | 'toolbar'; export type Paging = DevExpress.common.grids.PagingBase; export type Properties = dxDataGridOptions< TRowData, TKey >; /** * A grid row. */ export type Row = { /** * The data object represented by the row. */ readonly data: TRowData; /** * The group index of the row. Available when the rowType is 'group'. */ readonly groupIndex?: number; /** * Indicates whether the row is in the editing state. */ readonly isEditing?: boolean; /** * Indicates whether the row is expanded or collapsed. Available if rowType is 'data' or 'group'. */ readonly isExpanded?: boolean; /** * Indicates that the row is added, but not yet saved. Available if rowType is 'data'. */ readonly isNewRow?: boolean; /** * Indicates whether the row is selected. Available if rowType is 'data'. */ readonly isSelected?: boolean; /** * The key of the data object represented by the row. */ readonly key: TKey; /** * The visible index of the row. */ readonly rowIndex: number; /** * The row's type. */ readonly rowType: string; /** * Values of the row as they exist in the data source. */ readonly values: Array; }; /** * The type of the rowClick event handler's argument. */ export type RowClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly groupIndex?: number; /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly handled: boolean; }; /** * The type of the rowCollapsed event handler's argument. */ export type RowCollapsedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowCollapsing event handler's argument. */ export type RowCollapsingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowDblClick event handler's argument. */ export type RowDblClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxDataGrid, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly groupIndex?: number; /** * */ readonly rowElement: DevExpress.core.DxElement; }; export type RowDragging< TRowData = any, TKey = any > = DevExpress.common.grids.RowDragging; export type RowDraggingAddEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingChangeEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingEndEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingMoveEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingRemoveEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo; export type RowDraggingReorderEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragReorderInfo; export type RowDraggingStartEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.DragStartEventInfo; /** * The type of the rowExpanded event handler's argument. */ export type RowExpandedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowExpanding event handler's argument. */ export type RowExpandingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowInserted event handler's argument. */ export type RowInsertedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowInsertedInfo; /** * The type of the rowInserting event handler's argument. */ export type RowInsertingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowInsertingInfo; /** * The type of the rowPrepared event handler's argument. */ export type RowPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly groupIndex?: number; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly rowElement: DevExpress.core.DxElement; }; /** * The type of the rowRemoved event handler's argument. */ export type RowRemovedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowRemovedInfo; /** * The type of the rowRemoving event handler's argument. */ export type RowRemovingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowRemovingInfo; export type RowTemplateData = { readonly key: TKey; readonly data: TRowData; readonly component: dxDataGrid; readonly values: Array; readonly rowIndex: number; readonly columns: Array>; readonly isSelected?: boolean; readonly rowType: string; readonly groupIndex?: number; readonly isExpanded?: boolean; }; /** * The type of the rowUpdated event handler's argument. */ export type RowUpdatedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowUpdatedInfo; /** * The type of the rowUpdating event handler's argument. */ export type RowUpdatingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowUpdatingInfo; /** * The type of the rowValidating event handler's argument. */ export type RowValidatingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowValidatingInfo; /** * The type of the saved event handler's argument. */ export type SavedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * The type of the saving event handler's argument. */ export type SavingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.SavingInfo; /** * Configures scrolling. */ export type Scrolling = ScrollingBase & { /** * Specifies the scrolling mode. */ mode?: DataGridScrollMode; }; /** * @deprecated Use Scrolling instead * @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 ScrollingBase = DevExpress.common.grids.ScrollingBase; export type Selection = SelectionBase & { /** * Makes selection deferred. */ deferred?: boolean; /** * Specifies how to filter selected DataGrid rows based on sensitivity. */ sensitivity?: SelectionSensitivity; /** * Specifies the mode in which all the records are selected. Applies only if selection.allowSelectAll is true. */ selectAllMode?: DevExpress.common.SelectAllMode; /** * Specifies when to display the selection column and row selection checkboxes. Applies only if selection.mode is 'multiple'. */ showCheckBoxesMode?: DevExpress.common.grids.SelectionColumnDisplayMode; }; /** * @deprecated Use Selection instead * @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 SelectionBase = DevExpress.common.grids.SelectionBase; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.SelectionChangedInfo; export type SelectionSensitivity = 'base' | 'accent' | 'case' | 'variant'; /** * Allows you to sort groups according to the values of group summary items. */ export type SortByGroupSummaryInfoItem = { /** * Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied. */ groupColumn?: string | undefined; /** * Specifies the sort order of group summary item values. */ sortOrder?: DevExpress.common.SortOrder | undefined; /** * Specifies the group summary item whose values must be used to sort groups. */ summaryItem?: string | number | undefined; }; /** * Specifies the properties of the grid summary. */ export type Summary = { /** * Specifies a custom aggregate function. This function is called for summary items whose summaryType is 'custom'. */ calculateCustomSummary?: ( options: CustomSummaryInfo ) => void; /** * Specifies items of the group summary. */ groupItems?: Array | undefined; /** * Specifies whether to recalculate summaries while a user edits data. */ recalculateWhileEditing?: boolean; /** * Specifies whether to skip empty strings, null and undefined values when calculating a summary. Does not apply when you use a remote data source. */ skipEmptyValues?: boolean; /** * Contains properties that specify text patterns for summary items. */ texts?: SummaryTexts; /** * Specifies items of the total summary. */ totalItems?: Array | undefined; }; /** * Specifies items of the group summary. */ export type SummaryGroupItem = { /** * Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row. */ alignByColumn?: boolean; /** * Specifies the column that provides data for a group summary item. */ column?: string | undefined; /** * Customizes the text to be displayed in the summary item. */ customizeText?: (itemInfo: SummaryItemTextInfo) => string; /** * Specifies the summary item's text. */ displayFormat?: string | undefined; /** * Specifies the group summary item's identifier. */ name?: string | undefined; /** * Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row. */ showInColumn?: string | undefined; /** * Specifies whether or not a summary item must be displayed in the group footer. */ showInGroupFooter?: boolean; /** * Specifies whether to skip empty strings, null, and undefined values when calculating a summary. Does not apply when you use a remote data source. */ skipEmptyValues?: boolean; /** * Specifies how to aggregate data for the group summary item. */ summaryType?: DevExpress.common.grids.SummaryType | string | undefined; /** * Specifies a summary item value's display format. */ valueFormat?: DevExpress.common.core.localization.Format | undefined; }; export type SummaryItemTextInfo = { readonly value?: string | number | Date; readonly valueText: string; }; /** * Contains properties that specify text patterns for summary items. */ export type SummaryTexts = { /** * Specifies a pattern for the 'avg' summary items when they are displayed in the parent column. */ avg?: string; /** * Specifies a pattern for the 'avg' summary items displayed in a group row or in any other column rather than the parent one. */ avgOtherColumn?: string; /** * Specifies a pattern for the 'count' summary items. */ count?: string; /** * Specifies a pattern for the 'max' summary items when they are displayed in the parent column. */ max?: string; /** * Specifies a pattern for the 'max' summary items displayed in a group row or in any other column rather than the parent one. */ maxOtherColumn?: string; /** * Specifies a pattern for the 'min' summary items when they are displayed in the parent column. */ min?: string; /** * Specifies a pattern for the 'min' summary items displayed in a group row or in any other column rather than the parent one. */ minOtherColumn?: string; /** * Specifies a pattern for the 'sum' summary items when they are displayed in the parent column. */ sum?: string; /** * Specifies a pattern for the 'sum' summary items displayed in a group row or in any other column rather than the parent one. */ sumOtherColumn?: string; }; /** * Specifies items of the total summary. */ export type SummaryTotalItem = { /** * Specifies the alignment of a summary item. */ alignment?: DevExpress.common.HorizontalAlignment | undefined; /** * Specifies the column that provides data for a summary item. */ column?: string | undefined; /** * Specifies a CSS class to be applied to a summary item. */ cssClass?: string | undefined; /** * Customizes the text to be displayed in the summary item. */ customizeText?: (itemInfo: SummaryItemTextInfo) => string; /** * Specifies the summary item's text. */ displayFormat?: string | undefined; /** * Specifies the total summary item's identifier. */ name?: string | undefined; /** * Specifies the column that must hold the summary item. */ showInColumn?: string | undefined; /** * */ skipEmptyValues?: boolean; /** * Specifies how to aggregate data for the total summary item. */ summaryType?: DevExpress.common.grids.SummaryType | string | undefined; /** * Specifies a summary item value's display format. */ valueFormat?: DevExpress.common.core.localization.Format | undefined; }; /** * The type of the toolbarPreparing event handler's argument. */ export type ToolbarPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.ToolbarPreparingInfo; } /** * @deprecated Use the DevExpress.ui.dxDataGrid.Column type instead * @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 dxDataGridColumn extends DevExpress.ui.dxDataGrid.ColumnBase { /** * Specifies whether data from this column should be exported. Applies only if the column is visible. */ allowExporting?: boolean; /** * Specifies whether the user can group data by values of this column. Applies only when grouping is enabled. */ allowGrouping?: boolean; /** * Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this property makes sense only when grouping is allowed for this column. */ autoExpandGroup?: boolean; /** * Allows you to customize buttons in the edit column or create a custom command column. Applies only if the column's type is 'buttons'. */ buttons?: Array< | DevExpress.ui.dxDataGrid.DataGridPredefinedColumnButton | DevExpress.ui.dxDataGrid.ColumnButton >; /** * Sets custom column values used to group grid records. */ calculateGroupValue?: | string | ((this: DevExpress.ui.dxDataGrid.ColumnBase, rowData: TRowData) => any); /** * Specifies a custom template for data cells. */ cellTemplate?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxDataGrid.ColumnCellTemplateData< TRowData, TKey > ) => any); /** * An array of grid columns. */ columns?: | Array | string> | undefined; /** * Specifies a custom template for data cells in an editing state. */ editCellTemplate?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxDataGrid.ColumnEditCellTemplateData< TRowData, TKey > ) => any); /** * Specifies a custom template for group cells (group rows). */ groupCellTemplate?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxDataGrid.ColumnGroupCellTemplateData< TRowData, TKey > ) => any); /** * Specifies the index of a column when grid records are grouped by the values of this column. */ groupIndex?: number | undefined; /** * Specifies a custom template for column headers. */ headerCellTemplate?: | template | (( columnHeader: DevExpress.core.DxElement, headerInfo: DevExpress.ui.dxDataGrid.ColumnHeaderCellTemplateData< TRowData, TKey > ) => any); /** * Specifies whether or not to display the column when grid records are grouped by it. */ showWhenGrouped?: boolean; /** * Specifies the command column that this object customizes. */ type?: DevExpress.ui.dxDataGrid.DataGridCommandColumnType; } /** * @deprecated Use the DataGrid's ColumnButton type instead * @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 dxDataGridColumnButton extends DevExpress.ui.dxDataGrid.ColumnButtonBase { /** * The name used to identify a built-in button. */ name?: DevExpress.ui.dxDataGrid.DataGridPredefinedColumnButton | string; /** * A function that is executed when the button is clicked or tapped. */ onClick?: ( e: DevExpress.ui.dxDataGrid.ColumnButtonClickEvent ) => void; /** * Specifies a custom button template. */ template?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxDataGrid.ColumnButtonTemplateData< TRowData, TKey > ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the button's visibility. */ visible?: | boolean | ((options: { component?: dxDataGrid; row?: DevExpress.ui.dxDataGrid.Row; column?: DevExpress.ui.dxDataGrid.Column; }) => boolean); /** * Specifies whether the button is disabled. */ disabled?: | boolean | ((options: { component?: dxDataGrid; row?: DevExpress.ui.dxDataGrid.Row; column?: DevExpress.ui.dxDataGrid.Column; }) => boolean); } /** * * @deprecated */ export type dxDataGridOptions = Omit< DevExpress.common.grids.GridBaseOptions< dxDataGrid, TRowData, TKey >, DevExpress.ui.dxDataGrid.OverriddenKeys > & { /** * An array of grid columns. */ columns?: | Array | string> | undefined; /** * Customizes columns after they are created. */ customizeColumns?: ( columns: Array> ) => void; /** * Configures editing. */ editing?: DevExpress.ui.dxDataGrid.Editing; /** * Configures client-side exporting. */ export?: DevExpress.ui.dxDataGrid.Export; /** * Configures the group panel. */ groupPanel?: DevExpress.ui.dxDataGrid.GroupPanel; /** * Configures grouping. */ grouping?: DevExpress.ui.dxDataGrid.Grouping; /** * Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. This property applies only if data is a simple array. */ keyExpr?: string | Array | undefined; /** * Allows you to build a master-detail interface in the grid. */ masterDetail?: DevExpress.ui.dxDataGrid.MasterDetail; /** * A function that is executed when a cell is clicked or tapped. Executed before onRowClick. */ onCellClick?: ( e: DevExpress.ui.dxDataGrid.CellClickEvent ) => void; /** * A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick. */ onCellDblClick?: ( e: DevExpress.ui.dxDataGrid.CellDblClickEvent ) => void; /** * A function that is executed after the pointer enters or leaves a cell. */ onCellHoverChanged?: ( e: DevExpress.ui.dxDataGrid.CellHoverChangedEvent ) => void; /** * A function that is executed after a grid cell is created. */ onCellPrepared?: ( e: DevExpress.ui.dxDataGrid.CellPreparedEvent ) => void; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxDataGrid.ContextMenuPreparingEvent ) => void; /** * A function that is executed before a cell or row switches to the editing state. */ onEditingStart?: ( e: DevExpress.ui.dxDataGrid.EditingStartEvent ) => void; /** * A function that is executed after an editor is created. Not executed for cells with an editCellTemplate. */ onEditorPrepared?: ( options: DevExpress.ui.dxDataGrid.EditorPreparedEvent ) => void; /** * A function used to customize cell editors. Not executed for cells with an editCellTemplate. */ onEditorPreparing?: ( e: DevExpress.ui.dxDataGrid.EditorPreparingEvent ) => void; /** * A function that is executed before data is exported. */ onExporting?: ( e: DevExpress.ui.dxDataGrid.ExportingEvent ) => void; /** * A function that is executed after the focused cell changes. Applies only to cells in data or group rows. */ onFocusedCellChanged?: ( e: DevExpress.ui.dxDataGrid.FocusedCellChangedEvent ) => void; /** * A function that is executed before the focused cell changes. Applies only to cells in data or group rows. */ onFocusedCellChanging?: ( e: DevExpress.ui.dxDataGrid.FocusedCellChangingEvent ) => void; /** * A function that is executed after the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true. */ onFocusedRowChanged?: ( e: DevExpress.ui.dxDataGrid.FocusedRowChangedEvent ) => void; /** * A function that is executed before the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true. */ onFocusedRowChanging?: ( e: DevExpress.ui.dxDataGrid.FocusedRowChangingEvent ) => void; /** * A function that is executed when a row is clicked or tapped. */ onRowClick?: ( e: DevExpress.ui.dxDataGrid.RowClickEvent ) => void; /** * A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick. */ onRowDblClick?: ( e: DevExpress.ui.dxDataGrid.RowDblClickEvent ) => void; /** * A function that is executed after a row is created. */ onRowPrepared?: ( e: DevExpress.ui.dxDataGrid.RowPreparedEvent ) => void; /** * Specifies DataGrid operations to be executed on the server side. */ remoteOperations?: | boolean | { /** * Specifies whether or not filtering must be performed on the server side. */ filtering?: boolean; /** * Specifies whether paging by groups should be performed on the server side. */ groupPaging?: boolean; /** * Specifies whether or not grouping must be performed on the server side. */ grouping?: boolean; /** * Specifies whether or not paging must be performed on the server side. */ paging?: boolean; /** * Specifies whether or not sorting must be performed on the server side. */ sorting?: boolean; /** * Specifies whether or not summaries summaries are calculated on the server-side. */ summary?: boolean; } | DevExpress.common.Mode; /** * Specifies a custom template for rows. * @deprecated Use the dataRowTemplate option instead. */ rowTemplate?: | template | (( rowElement: DevExpress.core.DxElement, rowInfo: DevExpress.ui.dxDataGrid.RowTemplateData ) => any); /** * Specifies a custom template for data rows. */ dataRowTemplate?: | template | (( rowElement: DevExpress.core.DxElement, rowInfo: DevExpress.ui.dxDataGrid.DataRowTemplateData ) => any); /** * Configures scrolling. */ scrolling?: DevExpress.ui.dxDataGrid.Scrolling; /** * Configures runtime selection. */ selection?: DevExpress.ui.dxDataGrid.Selection; /** * Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true. */ selectionFilter?: string | Array | Function; /** * Allows you to sort groups according to the values of group summary items. */ sortByGroupSummaryInfo?: | Array | undefined; /** * Specifies the properties of the grid summary. */ summary?: DevExpress.ui.dxDataGrid.Summary; /** * Configures the toolbar. */ toolbar?: DevExpress.ui.dxDataGrid.Toolbar | undefined; }; /** * @deprecated Use DevExpress.ui.dxDataGrid.Row instead * @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 dxDataGridRowObject< TRowData = any, TKey = any > = DevExpress.ui.dxDataGrid.Row; /** * The DateBox is a UI component that displays date and time in a specified format, and enables a user to pick or type in the required date/time value. */ export class dxDateBox extends DateBoxBase { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxDateBox.Properties['value']): void; } module dxDateBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, ClipboardEvent >; export type DatePickerType = 'calendar' | 'list' | 'native' | 'rollers'; export type DateType = 'date' | 'datetime' | 'time'; export type DisabledDate = DevExpress.ui.dxCalendar.ComponentDisabledDate; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, ClipboardEvent >; export type Properties = dxDateBoxOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxDateBox, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxDateBoxOptions extends DateBoxBaseOptions { /** * Specifies whether or not adaptive UI component rendering is enabled on a small screen. */ adaptivityEnabled?: boolean; /** * Specifies the message displayed if the specified date is later than the max value or earlier than the min value. */ dateOutOfRangeMessage?: string; /** * Specifies dates that users cannot select. Applies only if pickerType is 'calendar'. */ disabledDates?: | Array | ((data: DevExpress.ui.dxDateBox.DisabledDate) => boolean); /** * Specifies the attributes to be passed on to the underlying HTML element. */ inputAttr?: any; /** * Specifies the interval between neighboring values in the popup list in minutes. */ interval?: number; /** * Specifies the message displayed if the typed value is not a valid date or time. */ invalidDateMessage?: string; /** * Specifies a text string used to annotate the editor's value. */ label?: string; /** * Specifies the maximum number of characters you can enter into the textbox. */ maxLength?: string | number; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies the type of the date/time picker. */ pickerType?: DevExpress.ui.dxDateBox.DatePickerType; /** * Specifies a placeholder for the input field. */ placeholder?: string; /** * Specifies whether to show the analog clock in the value picker. Applies only if type is 'datetime' and pickerType is 'calendar'. */ showAnalogClock?: boolean; /** * The read-only property that stores the text displayed by the UI component input element. */ text?: string; /** * A format used to display date/time information. */ type?: DevExpress.ui.dxDateBox.DateType; /** * Specifies the currently selected date and time. */ value?: DevExpress.common.DateLike; } /** * DateRangeBox is a UI component that allows a user to select a date range (pick or enter start and end dates). */ export class dxDateRangeBox extends DateRangeBoxBase { /** * Gets the `` element of the UI component's end date field. */ endDateField(): DevExpress.core.DxElement; /** * Gets the `` element of the UI component's start date field. */ startDateField(): DevExpress.core.DxElement; /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxDateRangeBox.Properties['value']): void; } module dxDateRangeBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, ClipboardEvent >; /** * */ export type Properties = Omit< DateBoxBaseOptions, 'inputAttr' | 'label' | 'maxLength' | 'name' | 'placeholder' | 'text' > & { /** * Specifies whether the UI component disables date selection before the start date and after the end date. */ disableOutOfRangeSelection?: boolean; /** * Specifies the range's end date. */ endDate?: DevExpress.common.DateLike; /** * Specifies the attributes passed to the end date input field. */ endDateInputAttr?: any; /** * Specifies the label of the end date input field. */ endDateLabel?: string; /** * Specifies the name attribute of the end date input field. */ endDateName?: string; /** * Specifies the message displayed if the specified end date is later than the max value or earlier than the min value. */ endDateOutOfRangeMessage?: string; /** * Specifies a placeholder for the end date input field. */ endDatePlaceholder?: string; /** * Returns the text displayed by the end date input field. */ endDateText?: string; /** * Specifies a message for invalid end date input. */ invalidEndDateMessage?: string; /** * Specifies a message for invalid start date input. */ invalidStartDateMessage?: string; /** * Specifies whether the UI component displays a single-month calendar or a multi-month calendar. */ multiView?: boolean; /** * Specifies whether a user can open the popup calendar by clicking an input field. */ openOnFieldClick?: boolean; /** * Specifies the start date of date range. */ startDate?: DevExpress.common.DateLike; /** * Specifies the attributes passed to the start date input field. */ startDateInputAttr?: any; /** * Specifies a label of the start date input field. */ startDateLabel?: string; /** * Specifies the name attribute of the start date input field. */ startDateName?: string; /** * Specifies the message displayed if the specified start date is later than the max value or earlier than the min value. */ startDateOutOfRangeMessage?: string; /** * Specifies a placeholder for the start date input field. */ startDatePlaceholder?: string; /** * Returns the text displayed by the start date input field. */ startDateText?: string; /** * An array that specifies the selected range (start and end dates). */ value?: DevExpress.common.DateLike[]; }; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxDateRangeBox, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * The DeferRendering is a UI component that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator. */ export class dxDeferRendering extends Widget {} module dxDeferRendering { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxDeferRenderingOptions; /** * The type of the rendered event handler's argument. */ export type RenderedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo; } /** * * @deprecated * @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 dxDeferRenderingOptions extends WidgetOptions { /** * Specifies the animation to be used to show the rendered content. */ animation?: DevExpress.common.core.animation.AnimationConfig | undefined; /** * A function that is executed when the content is rendered but not yet displayed. */ onRendered?: (e: DevExpress.ui.dxDeferRendering.RenderedEvent) => void; /** * A function that is executed when the content is displayed and animation is completed. */ onShown?: (e: DevExpress.ui.dxDeferRendering.ShownEvent) => void; /** * Specifies when the UI component content is rendered. */ renderWhen?: PromiseLike | boolean | undefined; /** * Indicates if a load indicator should be shown until the UI component's content is rendered. */ showLoadIndicator?: boolean; /** * Specifies a jQuery selector of items that should be rendered using a staggered animation. */ staggerItemSelector?: string | undefined; } /** * The Diagram UI component provides a visual interface to help you design new and modify existing diagrams. */ export class dxDiagram extends Widget { /** * Gets the DataSource instance. */ getNodeDataSource(): DevExpress.common.data.DataSource; /** * Returns the DataSource instance. */ getEdgeDataSource(): DevExpress.common.data.DataSource; /** * Returns a shape or connector object specified by its key. */ getItemByKey(key: Object): DevExpress.ui.dxDiagram.Item; /** * Returns a shape or connector object specified by its internal identifier. */ getItemById(id: string): DevExpress.ui.dxDiagram.Item; /** * Returns an array of diagram items. */ getItems(): Array; /** * Returns an array of selected diagram items. */ getSelectedItems(): Array; /** * Selects the specified items. */ setSelectedItems(items: Array): void; /** * Scrolls the view area to the specified item. */ scrollToItem(item: DevExpress.ui.dxDiagram.Item): void; /** * Exports the diagram data to a JSON object. */ export(): string; /** * Exports the diagram to an image format. */ exportTo( format: DevExpress.ui.dxDiagram.DiagramExportFormat, callback: Function ): void; /** * Imports the diagram data. */ import(data: string, updateExistingItemsOnly?: boolean): void; /** * Updates the diagram toolboxes. */ updateToolbox(): void; /** * Fits the diagram content into the work area. The maximum scale is 100%. */ fitToContent(): void; /** * Fits the diagram content's width into the work area width. The maximum scale is 100%. */ fitToWidth(): void; } module dxDiagram { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the customCommand event handler's argument. */ export type CustomCommandEvent = { /** * */ readonly component: dxDiagram; /** * */ readonly element: DevExpress.core.DxElement; /** * */ readonly name: string; }; export type CustomShapeTemplateData = { readonly item: dxDiagramShape; }; export type CustomShapeToolboxTemplateData = { readonly item: dxDiagramShape; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly item: Item; }; /** * The type of the itemDblClick event handler's argument. */ export type ItemDblClickEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly item: Item; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxDiagramOptions; /** * The type of the requestEditOperation event handler's argument. */ export type RequestEditOperationEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly operation: | 'addShape' | 'addShapeFromToolbox' | 'deleteShape' | 'deleteConnector' | 'changeConnection' | 'changeConnectorPoints'; /** * */ readonly args: | dxDiagramAddShapeArgs | dxDiagramAddShapeFromToolboxArgs | dxDiagramDeleteShapeArgs | dxDiagramDeleteConnectorArgs | dxDiagramChangeConnectionArgs | dxDiagramChangeConnectorPointsArgs | dxDiagramBeforeChangeShapeTextArgs | dxDiagramChangeShapeTextArgs | dxDiagramBeforeChangeConnectorTextArgs | dxDiagramChangeConnectorTextArgs | dxDiagramResizeShapeArgs | dxDiagramMoveShapeArgs; /** * */ readonly reason: RequestEditOperationReason; /** * */ allowed?: boolean; }; /** * The type of the requestLayoutUpdate event handler's argument. */ export type RequestLayoutUpdateEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly changes: any[]; /** * */ allowed?: boolean; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly items: Array; }; } /** * Contains information about the processed shape. * @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 dxDiagramAddShapeArgs { /** * The processed shape. */ shape?: dxDiagramShape; /** * A position where the shape is being added. */ position?: { /** * A horizontal position where the shape is being added. */ x?: number; /** * A vertical position where the shape is being added. */ y?: number; }; } /** * Contains information about the processed shape. * @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 dxDiagramAddShapeFromToolboxArgs { /** * The type of the processed shape. */ shapeType?: DevExpress.ui.dxDiagram.ShapeType | string; } /** * Contains information about the processed connector. * @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 dxDiagramBeforeChangeConnectorTextArgs { /** * The processed connector. */ connector?: dxDiagramConnector; /** * The index of the processed text in the connector's texts collection. */ index?: number; } /** * Contains information about the processed shape. * @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 dxDiagramBeforeChangeShapeTextArgs { /** * The processed shape. */ shape?: dxDiagramShape; } /** * Contains information about the processed connection. * @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 dxDiagramChangeConnectionArgs { /** * The new connected shape. */ newShape?: dxDiagramShape; /** * The previous connected shape. */ oldShape?: dxDiagramShape; /** * The processed connector. */ connector?: dxDiagramConnector; /** * The index of the processed point in the shape's connection point collection. */ connectionPointIndex?: number; /** * The position of the connector in the processed point. */ connectorPosition?: DevExpress.ui.dxDiagram.ConnectorPosition; } /** * Contains information about the processed connector. * @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 dxDiagramChangeConnectorPointsArgs { /** * The processed connector. */ connector?: dxDiagramConnector; /** * The array of new connection points. */ newPoints?: Array<{ /** * A horizontal position of the point. */ x?: number; /** * A vertical position of the point. */ y?: number; }>; /** * The array of previous connection points. */ oldPoints?: Array<{ /** * A horizontal position of the point. */ x?: number; /** * A vertical position of the point. */ y?: number; }>; } /** * Contains information about the processed connector. * @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 dxDiagramChangeConnectorTextArgs { /** * The processed connector. */ connector?: dxDiagramConnector; /** * The index of the processed text in the connector's texts collection. */ index?: number; /** * The new connector text. */ text?: string; } /** * Contains information about the processed shape. * @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 dxDiagramChangeShapeTextArgs { /** * The processed shape. */ shape?: dxDiagramShape; /** * The new shape text. */ text?: string; } /** * An object that provides information about a connector in the Diagram UI component. * @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 dxDiagramConnector extends DevExpress.ui.dxDiagram.Item { /** * Specifies the connector's start node key. */ fromKey?: any; /** * Gets the connector's start node identifier. */ fromId?: string; /** * The index of a shape connection point where the connector starts. */ fromPointIndex?: number; /** * Gets the connector's key points. */ points?: Array<{ /** * A horizontal position of the point. */ x?: number; /** * A vertical position of the point. */ y?: number; }>; /** * Specifies the connector's text. */ texts?: Array; /** * Specifies the connector's end node key. */ toKey?: any; /** * Gets the connector's end node identifier. */ toId?: string; /** * The index of the shape connection point where the connector ends. */ toPointIndex?: number; } /** * Contains information about the processed connector. * @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 dxDiagramDeleteConnectorArgs { /** * The processed connector. */ connector?: dxDiagramConnector; } /** * Contains information about the processed shape. * @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 dxDiagramDeleteShapeArgs { /** * The processed shape. */ shape?: dxDiagramShape; } /** * @deprecated Use Item instead * @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 dxDiagramItem { /** * Returns the data item that is bound to the diagram item. */ dataItem?: any; /** * Specifies the item's internal identifier. */ id?: string; /** * Gets the item's key from a data source. */ key?: Object; /** * Returns the type of the item. */ itemType?: DevExpress.ui.dxDiagram.ItemType; } /** * Contains information about the processed shape. * @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 dxDiagramMoveShapeArgs { /** * The processed shape. */ shape?: dxDiagramShape; /** * The new shape position. */ newPosition?: { /** * The new horizontal shape position specified in units. */ x?: number; /** * The new vertical shape position specified in units. */ y?: number; }; /** * The previous shape position. */ oldPosition?: { /** * The previous horizontal shape position specified in units. */ x?: number; /** * The previous vertical shape position specified in units. */ y?: number; }; } /** * * @deprecated * @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 dxDiagramOptions extends WidgetOptions { /** * Specifies how the Diagram UI component automatically zooms the work area. */ autoZoomMode?: DevExpress.ui.dxDiagram.AutoZoomMode; /** * Configures the context menu's settings. */ contextMenu?: { /** * Lists commands in the context menu. */ commands?: Array< DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Specifies whether the context menu is enabled. */ enabled?: boolean; }; /** * Configures the context toolbox's settings. */ contextToolbox?: { /** * Specifies the category of shapes that are displayed in the context toolbox. */ category?: DevExpress.ui.dxDiagram.ShapeCategory | string; /** * Specifies how shapes are displayed in the context toolbox. */ displayMode?: DevExpress.ui.dxDiagram.ToolboxDisplayMode; /** * Specifies the context toolbox's availability. */ enabled?: boolean; /** * Specifies the number of shape icons in a row. */ shapeIconsPerRow?: number; /** * Lists the shapes that are displayed in the context toolbox. The built-in shape types are shown in the Shape Types section. */ shapes?: Array | Array; /** * Specifies the context toolbox's width in pixels. */ width?: number; }; /** * A function that is executed after a custom command item was clicked and allows you to implement the custom command's logic. */ onCustomCommand?: (e: DevExpress.ui.dxDiagram.CustomCommandEvent) => void; /** * Specifies a custom template for shapes. */ customShapeTemplate?: | template | (( container: DevExpress.core.DxElement, data: DevExpress.ui.dxDiagram.CustomShapeTemplateData ) => any); /** * Specifies a custom template for shapes in the toolbox. */ customShapeToolboxTemplate?: | template | (( container: DevExpress.core.DxElement, data: DevExpress.ui.dxDiagram.CustomShapeToolboxTemplateData ) => any); /** * Provide access to an array of custom shapes. */ customShapes?: Array<{ /** * Specifies whether a card shape's image can be edited. */ allowEditImage?: boolean; /** * Specifies whether the shape's text can be edited. */ allowEditText?: boolean; /** * Specifies whether the shape can be resized. */ allowResize?: boolean; /** * Specifies the shape background image's fractional height. */ backgroundImageHeight?: number; /** * Specifies the shape background image's left offset. */ backgroundImageLeft?: number; /** * Specifies the shape background image's top offset. */ backgroundImageTop?: number; /** * Specifies the shape background image's URL. */ backgroundImageUrl?: string; /** * Specifies the shape image displayed in the toolbox. */ backgroundImageToolboxUrl?: string; /** * Specifies the shape background image's fractional width. */ backgroundImageWidth?: number; /** * Specifies the base shape type for the custom shape. The built-in shape types are shown in the Shape Types section. */ baseType?: DevExpress.ui.dxDiagram.ShapeType | string; /** * Specifies a category to which the custom shape belongs. */ category?: string; /** * An array of the shape's connection points. */ connectionPoints?: Array<{ /** * Specifies the horizontal offset. */ x?: number; /** * Specifies the vertical offset. */ y?: number; }>; /** * Specifies the initial height of the shape. */ defaultHeight?: number; /** * Specifies the URL of an image displayed in a card shape. */ defaultImageUrl?: string; /** * Specifies the initial text of the shape. */ defaultText?: string; /** * Specifies the initial width of the shape. */ defaultWidth?: number; /** * Specifies the shape image's fractional height. */ imageHeight?: number; /** * Specifies the shape image's left offset. */ imageLeft?: number; /** * Specifies the shape image's top offset. */ imageTop?: number; /** * Specifies the shape image's fractional width. */ imageWidth?: number; /** * Specifies whether the shape maintains its width-to-height ratio on auto resize. */ keepRatioOnAutoSize?: boolean; /** * Specifies the maximum height of the shape. */ maxHeight?: number; /** * Specifies the maximum width of the shape. */ maxWidth?: number; /** * Specifies the maximum height of the shape. */ minHeight?: number; /** * Specifies the minimum width of the shape. */ minWidth?: number; /** * Specifies a custom template for the shape. */ template?: | template | (( container: DevExpress.core.DxElement, data: DevExpress.ui.dxDiagram.CustomShapeTemplateData ) => any); /** * Specifies the shape template's fractional height. */ templateHeight?: number; /** * Specifies the shape template's left offset. */ templateLeft?: number; /** * Specifies the shape template's top offset. */ templateTop?: number; /** * Specifies the shape template's fractional width. */ templateWidth?: number; /** * Specifies the shape text container's height. */ textHeight?: number; /** * Specifies the shape text's left offset. */ textLeft?: number; /** * Specifies the shape text's top offset. */ textTop?: number; /** * Specifies the shape text container's width. */ textWidth?: number; /** * Specifies the shape's tooltip in the toolbox panel. */ title?: string; /** * Specifies a custom template for the shape in the toolbox. */ toolboxTemplate?: | template | (( container: DevExpress.core.DxElement, data: DevExpress.ui.dxDiagram.CustomShapeToolboxTemplateData ) => any); /** * Specifies the aspect ratio of the shape in the toolbox. */ toolboxWidthToHeightRatio?: number; /** * Specifies the custom shape's identifier. */ type?: string; }>; /** * Configures default item properties. */ defaultItemProperties?: { /** * Specifies a default item style. */ style?: Object; /** * Specifies an item's default text style. */ textStyle?: Object; /** * Specifies the default type of a connector. */ connectorLineType?: DevExpress.ui.dxDiagram.ConnectorLineType; /** * Specifies the default tip of a connector's start point. */ connectorLineStart?: DevExpress.ui.dxDiagram.ConnectorLineEnd; /** * Specifies the default tip of a connector's end point. */ connectorLineEnd?: DevExpress.ui.dxDiagram.ConnectorLineEnd; /** * Specifies the default minimum width of a shape. */ shapeMinWidth?: number | undefined; /** * Specifies the default maximum width of a shape. */ shapeMaxWidth?: number | undefined; /** * Specifies the default minimum height of a shape. */ shapeMinHeight?: number | undefined; /** * Specifies the default maximum height of a shape. */ shapeMaxHeight?: number | undefined; }; /** * Specifies which editing operations a user can perform. */ editing?: { /** * Specifies whether a user can add a shape. */ allowAddShape?: boolean; /** * Specifies whether a user can delete a shape. */ allowDeleteShape?: boolean; /** * Specifies whether a user can delete a connector. */ allowDeleteConnector?: boolean; /** * Specifies whether a user can change a connection. */ allowChangeConnection?: boolean; /** * Specifies whether a user can change connector points. */ allowChangeConnectorPoints?: boolean; /** * Specifies whether a user can change a connector's text. */ allowChangeConnectorText?: boolean; /** * Specifies whether a user can change a shape's text. */ allowChangeShapeText?: boolean; /** * Specifies whether a user can resize a shape. */ allowResizeShape?: boolean; /** * Specifies whether a user can move a shape. */ allowMoveShape?: boolean; }; /** * Allows you to bind the collection of diagram edges to a data source. For more information, see the Data Binding section. */ edges?: { /** * Specifies the name of a data source field or an expression that returns an edge's custom data. */ customDataExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Binds the edges collection to the specified data. Specify this property if you use node and edge data sources. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the name of a data source field or an expression that returns an edge's start node key. */ fromExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns an edge's line start tip. */ fromLineEndExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an index of a shape connection point where an edge starts. */ fromPointIndexExpr?: | string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge's key. */ keyExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns an edge's line type. */ lineTypeExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression whose Boolean value indicates whether an edge is locked. */ lockedExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge's key points. */ pointsExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge style. */ styleExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns edge text. */ textExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge's text style. */ textStyleExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge's end node key. */ toExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns an edge's line end tip. */ toLineEndExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an index of a shape connection point where an edge ends. */ toPointIndexExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an edge's z-index. */ zIndexExpr?: string | ((data: any, value?: any) => any) | undefined; }; /** * Configures export settings. */ export?: { /** * Specifies the name of the file to which the diagram is exported. */ fileName?: string; }; /** * Specifies whether or not to display the UI component in full-screen mode. */ fullScreen?: boolean; /** * Specifies the grid pitch. */ gridSize?: | number | { /** * An array that specifies the _Grid Size_ combobox items on 'Properties' panel. */ items?: Array; /** * Specifies the grid's pitch. */ value?: number; }; /** * Allows you to bind the collection of diagram nodes to a data source. For more information, see the Data Binding section. */ nodes?: { /** * Specifies an auto-layout algorithm that the UI component uses to build a diagram. */ autoLayout?: | DevExpress.ui.dxDiagram.DataLayoutType | { /** * Specifies the diagram layout orientation. */ orientation?: DevExpress.common.Orientation; /** * Specifies an auto-layout algorithm that is used to automatically arrange shapes. */ type?: DevExpress.ui.dxDiagram.DataLayoutType; }; /** * Specifies whether or not a shape size is automatically changed to fit the text when the UI component is bound to a data source. */ autoSizeEnabled?: boolean; /** * Specifies the name of a data source field or an expression that returns a key of a node's parent container node. */ containerKeyExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns a container's nested items. */ containerChildrenExpr?: | string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns a node's custom data. */ customDataExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Binds the nodes collection to the specified data. For more information, see the Data Binding section. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the name of a data source field or an expression that returns a node's height. */ heightExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns an image URL or Base64 encoded image for a node. */ imageUrlExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns a node's child items. */ itemsExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns node keys. */ keyExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns the x-coordinate of a node's left border. */ leftExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression whose Boolean value indicates whether a node is locked. */ lockedExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns a parent node key for a node. */ parentKeyExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns a node style. */ styleExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns node texts. */ textExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns a node's text style. */ textStyleExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns the y-coordinate of a node's top border. */ topExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns the shape type for a node. */ typeExpr?: string | ((data: any, value?: any) => any); /** * Specifies the name of a data source field or an expression that returns a node's width. */ widthExpr?: string | ((data: any, value?: any) => any) | undefined; /** * Specifies the name of a data source field or an expression that returns a node's z-index. */ zIndexExpr?: string | ((data: any, value?: any) => any) | undefined; }; /** * Indicates whether diagram content has unsaved changes. */ hasChanges?: boolean; /** * A function that is executed after a shape or connector is clicked. */ onItemClick?: (e: DevExpress.ui.dxDiagram.ItemClickEvent) => void; /** * A function that is executed after a shape or connector is double-clicked. */ onItemDblClick?: (e: DevExpress.ui.dxDiagram.ItemDblClickEvent) => void; /** * A function that is executed after the selection is changed in the Diagram. */ onSelectionChanged?: ( e: DevExpress.ui.dxDiagram.SelectionChangedEvent ) => void; /** * A function that allows you to prohibit an edit operation at run time. */ onRequestEditOperation?: ( e: DevExpress.ui.dxDiagram.RequestEditOperationEvent ) => void; /** * A function that allows you to specify whether or not the UI component should reapply its auto layout after diagram data is reloaded. */ onRequestLayoutUpdate?: ( e: DevExpress.ui.dxDiagram.RequestLayoutUpdateEvent ) => void; /** * Specifies the color of a diagram page. */ pageColor?: string; /** * Specifies the page orientation. */ pageOrientation?: DevExpress.common.PageOrientation; /** * Specifies a size of pages. */ pageSize?: { /** * Specifies the page height. */ height?: number; /** * An array that specifies the page size items in the _Page Size_ combobox on _Properties Panel_. */ items?: Array<{ /** * Specifies the page height. */ height?: number; /** * Specifies the display text. */ text?: string; /** * Specifies the page width. */ width?: number; }>; /** * Specifies the page width. */ width?: number; }; /** * Configures the Properties panel settings. */ propertiesPanel?: { /** * Contains an array of tabs in the Properties panel. */ tabs?: Array<{ /** * Lists commands in a tab. */ commands?: Array< | DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Contains an array of command groups in the tab. */ groups?: Array<{ /** * Lists commands in a group. */ commands?: Array< | DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Specifies a title of the group. */ title?: string; }>; /** * Specifies the tab's title. */ title?: string; }>; /** * Specifies the panel's visibility. */ visibility?: DevExpress.ui.dxDiagram.PanelVisibility; }; /** * Specifies whether the diagram is read-only. */ readOnly?: boolean; /** * Specifies whether grid lines are visible. */ showGrid?: boolean; /** * Switch the Diagram UI component to simple view mode. */ simpleView?: boolean; /** * Specifies whether or not the UI component uses native scrolling. */ useNativeScrolling?: boolean; /** * Specifies whether diagram elements should snap to grid lines. */ snapToGrid?: boolean; /** * Configures the main toolbar settings. */ mainToolbar?: { /** * Lists commands in the toolbar. */ commands?: Array< DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Specifies the toolbar's visibility. */ visible?: boolean; }; /** * Configures the history toolbar's settings. */ historyToolbar?: { /** * Lists commands in the history toolbar. */ commands?: Array< DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Specifies the history toolbar's visibility. */ visible?: boolean; }; /** * Configures the view toolbar settings. */ viewToolbar?: { /** * Lists commands in the toolbar. */ commands?: Array< DevExpress.ui.dxDiagram.CustomCommand | DevExpress.ui.dxDiagram.Command >; /** * Specifies the view toolbar's visibility. */ visible?: boolean; }; /** * Configures the toolbox settings. */ toolbox?: { /** * Lists toolbox groups. */ groups?: | Array<{ /** * Specifies the category of shapes that are displayed in the group. */ category?: DevExpress.ui.dxDiagram.ShapeCategory | string; /** * Specifies how shapes are displayed in the toolbox. */ displayMode?: DevExpress.ui.dxDiagram.ToolboxDisplayMode; /** * Specifies whether the group is expanded. */ expanded?: boolean; /** * Lists the shapes in the group. The built-in shape types are shown in the Shape Types section. */ shapes?: Array | Array; /** * Specifies the group title in the toolbox. */ title?: string; }> | Array; /** * Specifies the number of shape icons in a row. */ shapeIconsPerRow?: number; /** * Specifies whether the search box is visible. */ showSearch?: boolean; /** * Specifies the toolbar's visibility. */ visibility?: DevExpress.ui.dxDiagram.PanelVisibility; /** * Specifies the toolbox's width in pixels. */ width?: number | undefined; }; /** * Specifies the measurement unit for size properties. */ units?: DevExpress.ui.dxDiagram.Units; /** * Specifies the measurement unit that is displayed in user interface elements. */ viewUnits?: DevExpress.ui.dxDiagram.Units; /** * Specifies the zoom level. */ zoomLevel?: | number | { /** * An array that specifies the zoom level items in the _Zoom Level_ combobox on 'Properties' panel. */ items?: Array; /** * Specifies the zoom level. */ value?: number | undefined; }; } /** * Contains information about the processed shape. * @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 dxDiagramResizeShapeArgs { /** * The processed shape. */ shape?: dxDiagramShape; /** * The new shape size. */ newSize?: { /** * The new shape height. */ height?: number; /** * The new shape width. */ width?: number; }; /** * The previous shape size. */ oldSize?: { /** * The previous shape height. */ height?: number; /** * The previous shape width. */ width?: number; }; } /** * An object that provides information about a shape in the Diagram UI component. * @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 dxDiagramShape extends DevExpress.ui.dxDiagram.Item { /** * Specifies the shape's text. */ text?: string; /** * Specifies the shape type. The built-in shape types are shown in the Shape Types section. */ type?: DevExpress.ui.dxDiagram.ShapeType | string; /** * Specifies the position of the top left shape corner relative to the top left corner of the diagram work area. */ position?: { /** * The horizontal shape position specified in units. */ x?: number; /** * The vertical shape position specified in units. */ y?: number; }; /** * Specifies the shape size. */ size?: { /** * The shape height specified in units. */ height?: number; /** * The shape width specified in units. */ width?: number; }; /** * Gets an array of attached connector identifiers. */ attachedConnectorIds?: Array; /** * Gets the identifier of the container that stores the shape. */ containerId?: string; /** * Gets identifiers of shapes stored in the container. */ containerChildItemIds?: Array; /** * Gets whether the container is expanded. */ containerExpanded?: boolean; } /** * Draggable is a user interface utility that allows UI component elements to be dragged and dropped. */ export class dxDraggable extends DOMComponent implements DraggableBase {} module dxDraggable { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the dragEnd event handler's argument. */ export type DragEndEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxDraggable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement?: DevExpress.core.DxElement; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; }; /** * The type of the dragMove event handler's argument. */ export type DragMoveEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxDraggable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement?: DevExpress.core.DxElement; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; }; /** * The type of the dragStart event handler's argument. */ export type DragStartEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxDraggable, DevExpress.events.PointerInteractionEvent > & { /** * */ itemData?: any; /** * */ readonly itemElement?: DevExpress.core.DxElement; /** * */ readonly fromData?: any; }; export type DragTemplateData = { readonly itemData?: any; readonly itemElement: DevExpress.core.DxElement; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxDraggableOptions; } /** * * @deprecated * @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 dxDraggableOptions extends DraggableBaseOptions { /** * Allows a user to drag clones of items instead of actual items. */ clone?: boolean; /** * Specifies custom markup to be shown instead of the item being dragged. */ dragTemplate?: | template | (( dragInfo: DevExpress.ui.dxDraggable.DragTemplateData, containerElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * A function that is called when a drag gesture is finished. */ onDragEnd?: (e: DevExpress.ui.dxDraggable.DragEndEvent) => void; /** * A function that is called every time a draggable item is moved. */ onDragMove?: (e: DevExpress.ui.dxDraggable.DragMoveEvent) => void; /** * A function that is called when a drag gesture is initialized. */ onDragStart?: (e: DevExpress.ui.dxDraggable.DragStartEvent) => void; } /** * The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts. */ export class dxDrawer extends Widget { /** * Gets the drawer's content. */ content(): DevExpress.core.DxElement; /** * Closes the drawer. */ hide(): DevExpress.core.utils.DxPromise; /** * Opens the drawer. */ show(): DevExpress.core.utils.DxPromise; /** * Opens or closes the drawer, reversing the current state. */ toggle(): DevExpress.core.utils.DxPromise; } module dxDrawer { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; export type OpenedStateMode = 'overlap' | 'shrink' | 'push'; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type PanelLocation = | 'left' | 'right' | 'top' | 'bottom' | 'before' | 'after'; export type Properties = dxDrawerOptions; export type RevealMode = 'slide' | 'expand'; } /** * * @deprecated * @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 dxDrawerOptions extends WidgetOptions { /** * Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true. */ animationDuration?: number; /** * Specifies whether to use an opening and closing animation. */ animationEnabled?: boolean; /** * Specifies whether to close the drawer if a user clicks or taps the view area. */ closeOnOutsideClick?: | boolean | (( event: DevExpress.events.DxEvent ) => boolean); /** * Specifies the drawer's width or height (depending on the drawer's position) in the opened state. */ maxSize?: number; /** * Specifies the drawer's width or height (depending on the drawer's position) in the closed state. */ minSize?: number; /** * Specifies whether the drawer is opened. */ opened?: boolean; /** * Specifies how the drawer interacts with the view in the opened state. */ openedStateMode?: DevExpress.ui.dxDrawer.OpenedStateMode; /** * Specifies the drawer's position in relation to the view. */ position?: DevExpress.ui.dxDrawer.PanelLocation; /** * Specifies the drawer's reveal mode. */ revealMode?: DevExpress.ui.dxDrawer.RevealMode; /** * Specifies whether to shade the view when the drawer is opened. */ shading?: boolean; /** * Specifies the drawer's content. */ template?: template | ((Element: DevExpress.core.DxElement) => any); } /** * The DropDownBox UI component consists of a text field, which displays the current value, and a drop-down field, which can contain any UI element. */ export class dxDropDownBox extends dxDropDownEditor { getDataSource(): DevExpress.common.data.DataSource; } module dxDropDownBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; export type ContentTemplateData = { component: dxDropDownBox; readonly value?: any; }; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, ClipboardEvent >; export type Properties = dxDropDownBoxOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownBox, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxDropDownBoxOptions extends DataExpressionMixinOptions, dxDropDownEditorOptions { /** * Specifies whether the UI component allows a user to enter a custom value. */ acceptCustomValue?: boolean; /** * Specifies a custom template for the drop-down content. */ contentTemplate?: | template | (( templateData: DevExpress.ui.dxDropDownBox.ContentTemplateData, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Customizes text before it is displayed in the input field. */ displayValueFormatter?: (value: string | Array) => string; /** * Specifies a custom template for the text field. Must contain the TextBox UI component. */ fieldTemplate?: | template | (( value: any, fieldElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * An array of items used to synchronize the DropDownBox with an embedded UI component. */ items?: Array; /** * Specifies whether a user can open the drop-down list by clicking a text field. */ openOnFieldClick?: boolean; /** * Specifies the DOM events after which the UI component's value should be updated. */ valueChangeEvent?: string; /** * Configures the drop-down field which holds the content. */ dropDownOptions?: DevExpress.ui.dxPopup.Properties; } /** * The DropDownButton is a button that opens a drop-down menu. */ export class dxDropDownButton extends Widget { /** * Closes the drop-down menu. */ close(): DevExpress.core.utils.DxPromise; getDataSource(): DevExpress.common.data.DataSource; /** * Opens the drop-down menu. */ open(): DevExpress.core.utils.DxPromise; /** * Opens or closes the drop-down menu, reversing the current state. */ toggle(): DevExpress.core.utils.DxPromise; /** * Opens or closes the drop-down menu, depending on the argument. */ toggle(visibility: boolean): DevExpress.core.utils.DxPromise; } module dxDropDownButton { /** * The type of the buttonClick event handler's argument. */ export type ButtonClickEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownButton, KeyboardEvent | MouseEvent | PointerEvent > & { /** * */ readonly selectedItem?: any; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxDropDownButton, KeyboardEvent | MouseEvent | PointerEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxDropDownButtonOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly item: any; /** * */ readonly previousItem: any; }; } /** * @deprecated Use Item instead * @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 dxDropDownButtonItem extends DevExpress.ui.dxList.Item { /** * A handler for the click event raised for a certain item in the drop-down field. */ onClick?: | ((e: DevExpress.ui.dxDropDownButton.ItemClickEvent) => void) | string; } /** * * @deprecated * @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 dxDropDownButtonOptions extends WidgetOptions { /** * Provides data for the drop-down menu. */ dataSource?: DevExpress.data.DataSourceLike< DevExpress.ui.dxDropDownButton.Item | any > | null; /** * Specifies whether to wait until the drop-down menu is opened the first time to render its content. Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately. */ deferRendering?: boolean; /** * Specifies the data field whose values should be displayed in the drop-down menu. */ displayExpr?: string | ((itemData: any) => string) | undefined; /** * Specifies custom content for the drop-down field. */ dropDownContentTemplate?: | template | (( data: | Array | DevExpress.common.data.DataSource, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Configures the drop-down field. */ dropDownOptions?: DevExpress.ui.dxPopup.Properties; /** * Specifies whether users can use keyboard to focus the UI component. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user hovers the mouse pointer over it. */ hoverStateEnabled?: boolean; /** * Specifies the button's icon. */ icon?: string | undefined; /** * Specifies a custom template for drop-down menu items. */ itemTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Provides drop-down menu items. */ items?: Array; /** * Specifies which data field provides keys used to distinguish between the selected drop-down menu items. */ keyExpr?: string; /** * Specifies the text or HTML markup displayed in the drop-down menu when it does not contain any items. */ noDataText?: string; /** * A function that is executed when the button is clicked or tapped. If splitButton is true, this function is executed for the action button only. */ onButtonClick?: | ((e: DevExpress.ui.dxDropDownButton.ButtonClickEvent) => void) | string; /** * A function that is executed when a drop-down menu item is clicked. */ onItemClick?: | ((e: DevExpress.ui.dxDropDownButton.ItemClickEvent) => void) | string; /** * A function that is executed when an item is selected or selection is canceled. In effect when useSelectMode is true. */ onSelectionChanged?: | ((e: DevExpress.ui.dxDropDownButton.SelectionChangedEvent) => void) | string; /** * Specifies whether the drop-down menu is opened. */ opened?: boolean; /** * Contains the selected item's data. Available when useSelectMode is true. */ selectedItem?: string | number | any; /** * Contains the selected item's key and allows you to specify the initially selected item. Applies when useSelectMode is true. */ selectedItemKey?: string | number; /** * Specifies whether the arrow icon should be displayed. */ showArrowIcon?: boolean; /** * Specifies whether to split the button in two: one executes an action, the other opens and closes the drop-down menu. */ splitButton?: boolean; /** * Specifies how the button is styled. */ stylingMode?: DevExpress.common.ButtonStyle; /** * Specifies a custom template for the base button in DropDownButton. */ template?: | template | (( data: DevExpress.ui.dxButton.TemplateData, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the button's text. Applies only if useSelectMode is false. */ text?: string; /** * Specifies the drop-down button type. */ type?: DevExpress.common.ButtonType | string; /** * Specifies whether the UI component stores the selected drop-down menu item. */ useSelectMode?: boolean; /** * Specifies whether text that exceeds the drop-down list width should be wrapped. */ wrapItemText?: boolean; /** * Specifies whether the widget uses item's text a title attribute. */ useItemTextAsTitle?: boolean; } /** * A drop-down editor UI component. * @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 dxDropDownEditor< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.dxDropDownEditor.Properties > extends dxTextBox { /** * Closes the drop-down editor. */ close(): void; /** * Gets the popup window's content. */ content(): DevExpress.core.DxElement; /** * Gets the UI component's `` element. */ field(): DevExpress.core.DxElement; /** * Opens the drop-down editor. */ open(): void; /** * Resets the value property to the value passed as an argument. */ reset(value?: TProperties['value']): void; } module dxDropDownEditor { /** * @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 DropDownButtonTemplateDataModel { readonly text?: string; readonly icon?: 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. */ interface DropDownEditorInstance extends dxDropDownEditor {} export type DropDownPredefinedButton = 'clear' | 'dropDown'; /** * @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. */ type Properties = dxDropDownEditorOptions; } /** * * @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 dxDropDownEditorOptions extends Omit, 'validationMessagePosition'> { /** * Specifies whether or not the UI component allows an end user to enter a custom value. */ acceptCustomValue?: boolean; /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies the way an end user applies the selected value. */ applyValueMode?: DevExpress.common.ApplyValueMode; /** * Configures the drop-down field which holds the content. */ dropDownOptions?: | DevExpress.ui.dxPopup.Properties | DevExpress.ui.dxPopover.Properties; /** * Allows you to add custom buttons to the input text field. */ buttons?: Array< | DevExpress.ui.dxDropDownEditor.DropDownPredefinedButton | DevExpress.common.TextEditorButton >; /** * Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. */ deferRendering?: boolean; /** * Specifies a custom template for the drop-down button. */ dropDownButtonTemplate?: | template | (( buttonData: DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * A function that is executed once the drop-down editor is closed. */ onClosed?: (e: DevExpress.common.core.events.EventInfo) => void; /** * A function that is executed once the drop-down editor is opened. */ onOpened?: (e: DevExpress.common.core.events.EventInfo) => void; /** * Specifies whether a user can open the drop-down list by clicking a text field. */ openOnFieldClick?: boolean; /** * Specifies whether or not the drop-down editor is displayed. */ opened?: boolean; /** * Specifies whether the drop-down button is visible. */ showDropDownButton?: boolean; /** * Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. */ validationMessagePosition?: | DevExpress.common.Position | DevExpress.common.Mode; /** * Specifies the currently selected value. */ value?: any; } /** * A base class for drop-down list 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 dxDropDownList< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue > extends dxDropDownEditor { getDataSource(): DevExpress.common.data.DataSource; } module dxDropDownList { /** * * @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 SelectionChangedInfo { /** * */ readonly selectedItem: T; } } /** * * @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 dxDropDownListOptions extends DataExpressionMixinOptions, dxDropDownEditorOptions { /** * Returns the value currently displayed by the UI component. */ displayValue?: string | undefined; /** * Specifies a custom template for group captions. */ groupTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether data items should be grouped. */ grouped?: boolean; /** * The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true. */ minSearchLength?: number; /** * Specifies the text or HTML markup displayed by the UI component if the item collection is empty. */ noDataText?: string; /** * A function that is executed when a list item is clicked or tapped. */ onItemClick?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo ) => void; /** * A function that is executed when a list item is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.ui.dxDropDownList.SelectionChangedInfo ) => void; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo ) => void; /** * Specifies whether to allow search operations. */ searchEnabled?: boolean; /** * Specifies the name of a data source item field or an expression whose value is compared to the search criterion. */ searchExpr?: string | Function | Array; /** * Specifies a comparison operation used to search UI component items. */ searchMode?: DevExpress.common.SimplifiedSearchMode; /** * Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. */ searchTimeout?: number; /** * Gets the currently selected item. */ selectedItem?: any; /** * Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value. */ showDataBeforeSearch?: boolean; /** * Specifies the currently selected value. May be an object if dataSource contains objects, the store key is specified, and valueExpr is not set. */ value?: any; /** * Specifies the DOM events after which the UI component's value should be updated. */ valueChangeEvent?: string; /** * Specifies whether text that exceeds the drop-down list width should be wrapped. */ wrapItemText?: boolean; /** * Specifies whether the widget uses item's text a title attribute. */ useItemTextAsTitle?: boolean; } /** * The FileManager is a UI component that allows users to upload, select, and manage files and directories in different file storages. */ export class dxFileManager extends Widget { /** * Gets the current directory object. */ getCurrentDirectory(): any; /** * Gets the selected items. */ getSelectedItems(): Array; /** * Reloads data and repaints the UI component. */ refresh(): DevExpress.core.utils.DxPromise; } module dxFileManager { /** * * @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 ActionEventInfo { /** * */ errorCode?: number; /** * */ errorText: string; /** * */ cancel: boolean | PromiseLike; } /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contextMenuItemClick event handler's argument. */ export type ContextMenuItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxFileManager, KeyboardEvent | PointerEvent | MouseEvent > & { /** * */ readonly itemData: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly itemIndex: number; /** * */ readonly fileSystemItem?: DevExpress.fileManagement.FileSystemItem; /** * */ readonly viewArea: FileManagerViewArea; }; /** * The type of the contextMenuShowing event handler's argument. */ export type ContextMenuShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxFileManager, KeyboardEvent | PointerEvent | MouseEvent > & { /** * */ readonly fileSystemItem?: DevExpress.fileManagement.FileSystemItem; /** * */ readonly targetElement?: DevExpress.core.DxElement; /** * */ readonly viewArea: FileManagerViewArea; }; /** * The type of the currentDirectoryChanged event handler's argument. */ export type CurrentDirectoryChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly directory: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the directoryCreated event handler's argument. */ export type DirectoryCreatedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly parentDirectory: DevExpress.fileManagement.FileSystemItem; /** * */ readonly name: string; }; /** * The type of the directoryCreating event handler's argument. */ export type DirectoryCreatingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly parentDirectory: DevExpress.fileManagement.FileSystemItem; /** * */ readonly name: string; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the errorOccurred event handler's argument. */ export type ErrorOccurredEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly errorCode?: number; /** * */ errorText?: string; /** * */ readonly fileSystemItem?: DevExpress.fileManagement.FileSystemItem; }; /** * @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 FileManagerItemViewMode = 'details' | 'thumbnails'; export type FileManagerPredefinedContextMenuItem = | 'create' | 'upload' | 'refresh' | 'download' | 'move' | 'copy' | 'rename' | 'delete'; export type FileManagerPredefinedToolbarItem = | 'showNavPane' | 'create' | 'upload' | 'refresh' | 'switchView' | 'download' | 'move' | 'copy' | 'rename' | 'delete' | 'clearSelection' | 'separator'; /** * @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 FileManagerViewArea = 'navPane' | 'itemView'; /** * The type of the fileUploaded event handler's argument. */ export type FileUploadedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly fileData: File; /** * */ readonly parentDirectory: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the fileUploading event handler's argument. */ export type FileUploadingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly fileData: File; /** * */ readonly destinationDirectory: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the focusedItemChanged event handler's argument. */ export type FocusedItemChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly item?: DevExpress.fileManagement.FileSystemItem; /** * */ readonly itemElement?: DevExpress.core.DxElement; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemCopied event handler's argument. */ export type ItemCopiedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly sourceItem: DevExpress.fileManagement.FileSystemItem; /** * */ readonly parentDirectory: DevExpress.fileManagement.FileSystemItem; /** * */ readonly itemName: string; /** * */ readonly itemPath: string; }; /** * The type of the itemCopying event handler's argument. */ export type ItemCopyingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; /** * */ readonly destinationDirectory: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the itemDeleted event handler's argument. */ export type ItemDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the itemDeleting event handler's argument. */ export type ItemDeletingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the itemDownloading event handler's argument. */ export type ItemDownloadingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the itemMoved event handler's argument. */ export type ItemMovedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly sourceItem: DevExpress.fileManagement.FileSystemItem; /** * */ readonly parentDirectory: DevExpress.fileManagement.FileSystemItem; /** * */ readonly itemName: string; /** * */ readonly itemPath: string; }; /** * The type of the itemMoving event handler's argument. */ export type ItemMovingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; /** * */ readonly destinationDirectory: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the itemRenamed event handler's argument. */ export type ItemRenamedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly sourceItem: DevExpress.fileManagement.FileSystemItem; /** * */ readonly itemName: string; }; /** * The type of the itemRenaming event handler's argument. */ export type ItemRenamingEvent = DevExpress.common.core.events.EventInfo & ActionEventInfo & { /** * */ readonly item: DevExpress.fileManagement.FileSystemItem; /** * */ readonly newName: string; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxFileManagerOptions; /** * The type of the selectedFileOpened event handler's argument. */ export type SelectedFileOpenedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly file: DevExpress.fileManagement.FileSystemItem; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly currentSelectedItemKeys: Array; /** * */ readonly currentDeselectedItemKeys: Array; /** * */ readonly selectedItems: Array; /** * */ readonly selectedItemKeys: Array; }; /** * The type of the toolbarItemClick event handler's argument. */ export type ToolbarItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxFileManager, PointerEvent | MouseEvent > & { /** * */ readonly itemData: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly itemIndex: number; }; } /** * Configures the context menu. * @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 dxFileManagerContextMenu { /** * Configures context menu items' settings. */ items?: Array< | DevExpress.ui.dxFileManager.ContextMenuItem | DevExpress.ui.dxFileManager.FileManagerPredefinedContextMenuItem >; } /** * @deprecated Use DevExpress.ui.dxFileManager.ContextMenuItem instead * @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 dxFileManagerContextMenuItem extends DevExpress.ui.dxContextMenu.Item { /** * Configures settings of a context menu item's subitems. */ items?: Array; /** * Specifies the context menu item's name. */ name?: | DevExpress.ui.dxFileManager.FileManagerPredefinedContextMenuItem | string; /** * Specifies the context menu item's visibility. */ visible?: boolean | undefined; /** * */ template?: template | (() => string | DevExpress.core.UserDefinedElement); } /** * Configures the column. * @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 dxFileManagerDetailsColumn { /** * Specifies the column alignment. */ alignment?: DevExpress.common.HorizontalAlignment | undefined; /** * Specifies the column caption. */ caption?: string | undefined; /** * Specifies a CSS class to be applied to the column. */ cssClass?: string | undefined; /** * Specifies which data field provides data for the column. */ dataField?: string | undefined; /** * Casts column values to a specific data type. */ dataType?: DevExpress.common.DataType | undefined; /** * Specifies the order in which columns are hidden when the UI component adapts to the screen or container size. */ hidingPriority?: number | undefined; /** * Specifies the order in which the column is sorted. */ sortIndex?: number | undefined; /** * Specifies the sort order of column values. */ sortOrder?: DevExpress.common.SortOrder | undefined; /** * Specifies the column visibility. */ visible?: boolean; /** * Specifies the position of the column in the resulting UI component. */ visibleIndex?: number | undefined; /** * Specifies the column width. */ width?: number | string | undefined; } /** * * @deprecated * @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 dxFileManagerOptions extends WidgetOptions { /** * Specifies the allowed upload file extensions. */ allowedFileExtensions?: Array; /** * Configures the context menu settings. */ contextMenu?: dxFileManagerContextMenu; /** * Specifies the path that is used when the FileManager is initialized. */ currentPath?: string; /** * Specifies an array of path keys to the current location. */ currentPathKeys?: Array; /** * Customizes columns in details view. Applies only if itemView.mode is 'details'. */ customizeDetailColumns?: ( columns: Array ) => Array; /** * Allows you to provide custom icons to be used as thumbnails. */ customizeThumbnail?: ( fileSystemItem: DevExpress.fileManagement.FileSystemItem ) => string; /** * Specifies the file system provider. */ fileSystemProvider?: any; /** * Configures the file and directory view. */ itemView?: { /** * Configures the 'Details' file system representation mode. */ details?: { /** * Configures the columns. */ columns?: Array; }; /** * Specifies the file system representation mode. */ mode?: DevExpress.ui.dxFileManager.FileManagerItemViewMode; /** * Specifies whether to display folders in the view. When this property is false, folders are displayed in the navigation pane only. */ showFolders?: boolean; /** * Specifies whether to display the parent directory in the view. */ showParentFolder?: boolean; }; /** * Configures notification settings. */ notifications?: { /** * Specifies whether to show the progress panel. */ showPanel?: boolean; /** * Specifies whether to show the pop-up notification window. */ showPopup?: boolean; }; /** * A function that is executed when a context menu item is clicked. */ onContextMenuItemClick?: ( e: DevExpress.ui.dxFileManager.ContextMenuItemClickEvent ) => void; /** * A function that is executed before a context menu is displayed. */ onContextMenuShowing?: ( e: DevExpress.ui.dxFileManager.ContextMenuShowingEvent ) => void; /** * A function that is executed when the current directory is changed. */ onCurrentDirectoryChanged?: ( e: DevExpress.ui.dxFileManager.CurrentDirectoryChangedEvent ) => void; /** * A function that is executed when the selected file is opened. */ onSelectedFileOpened?: ( e: DevExpress.ui.dxFileManager.SelectedFileOpenedEvent ) => void; /** * A function that is executed when a file system item is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.ui.dxFileManager.SelectionChangedEvent ) => void; /** * A function that is executed when a toolbar item is clicked. */ onToolbarItemClick?: ( e: DevExpress.ui.dxFileManager.ToolbarItemClickEvent ) => void; /** * A function that is executed when the focused item is changed. */ onFocusedItemChanged?: ( e: DevExpress.ui.dxFileManager.FocusedItemChangedEvent ) => void; /** * A function that is executed when an error occurs. */ onErrorOccurred?: ( e: DevExpress.ui.dxFileManager.ErrorOccurredEvent ) => void; /** * A function that is executed before a directory is created. */ onDirectoryCreating?: ( e: DevExpress.ui.dxFileManager.DirectoryCreatingEvent ) => void; /** * A function that is executed when a directory is created. */ onDirectoryCreated?: ( e: DevExpress.ui.dxFileManager.DirectoryCreatedEvent ) => void; /** * A function that is executed before a file or directory is renamed. */ onItemRenaming?: (e: DevExpress.ui.dxFileManager.ItemRenamingEvent) => void; /** * A function that is executed when a file or directory is renamed. */ onItemRenamed?: (e: DevExpress.ui.dxFileManager.ItemRenamedEvent) => void; /** * A function that is executed before a file or directory is moved. */ onItemMoving?: (e: DevExpress.ui.dxFileManager.ItemMovingEvent) => void; /** * A function that is executed when a file or directory is moved. */ onItemMoved?: (e: DevExpress.ui.dxFileManager.ItemMovedEvent) => void; /** * A function that is executed before a file or directory is copied. */ onItemCopying?: (e: DevExpress.ui.dxFileManager.ItemCopyingEvent) => void; /** * A function that is executed when a file or directory is copied. */ onItemCopied?: (e: DevExpress.ui.dxFileManager.ItemCopiedEvent) => void; /** * A function that is executed before a file or directory is deleted. */ onItemDeleting?: (e: DevExpress.ui.dxFileManager.ItemDeletingEvent) => void; /** * A function that is executed when a file or directory is deleted. */ onItemDeleted?: (e: DevExpress.ui.dxFileManager.ItemDeletedEvent) => void; /** * A function that is executed before the file is uploaded. */ onFileUploading?: ( e: DevExpress.ui.dxFileManager.FileUploadingEvent ) => void; /** * A function that is executed when a file is successfully uploaded. */ onFileUploaded?: (e: DevExpress.ui.dxFileManager.FileUploadedEvent) => void; /** * A function that is executed before a file is downloaded. */ onItemDownloading?: ( e: DevExpress.ui.dxFileManager.ItemDownloadingEvent ) => void; /** * Specifies actions that a user is allowed to perform on files and directories. */ permissions?: { /** * Specifies whether a user is allowed to copy files and directories. */ copy?: boolean; /** * Specifies whether a user is allowed to create files and directories. */ create?: boolean; /** * Specifies whether a user is allowed to download files. */ download?: boolean; /** * Specifies whether a user is allowed to move files and directories. */ move?: boolean; /** * Specifies whether a user is allowed to delete files and directories. */ delete?: boolean; /** * Specifies whether a user is allowed to rename files and directories. */ rename?: boolean; /** * Specifies whether a user is allowed to upload files. */ upload?: boolean; }; /** * Specifies the root directory display name. */ rootFolderName?: string; /** * Specifies whether a user can select a single or multiple files and directories in the item view simultaneously. */ selectionMode?: DevExpress.common.SingleOrMultiple; /** * Contains an array of initially or currently selected files and directories' keys. */ selectedItemKeys?: Array; /** * Specifies a key of the initially or currently focused item. */ focusedItemKey?: string; /** * Configures toolbar settings. */ toolbar?: dxFileManagerToolbar; /** * Configures upload settings. */ upload?: { /** * Specifies the maximum upload file size, in bytes. */ maxFileSize?: number; /** * Specifies a chunk size, in bytes. */ chunkSize?: number; }; } /** * Configures the toolbar. * @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 dxFileManagerToolbar { /** * Configures settings of the toolbar items that are visible when users select files. */ fileSelectionItems?: Array< | DevExpress.ui.dxFileManager.ToolbarItem | DevExpress.ui.dxFileManager.FileManagerPredefinedToolbarItem >; /** * Configures toolbar items' settings. */ items?: Array< | DevExpress.ui.dxFileManager.ToolbarItem | DevExpress.ui.dxFileManager.FileManagerPredefinedToolbarItem >; } /** * @deprecated Use ToolbarItem instead * @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 dxFileManagerToolbarItem extends DevExpress.ui.dxToolbar.Item { /** * Specifies the icon to be displayed on the toolbar item. */ icon?: string; /** * Specifies the toolbar item's location. */ location?: DevExpress.common.ToolbarItemLocation; /** * Specifies the toolbar item's name. */ name?: | DevExpress.ui.dxFileManager.FileManagerPredefinedToolbarItem | string; /** * Specifies the toolbar item's visibility. */ visible?: boolean | undefined; /** * */ html?: string; /** * */ template?: template | (() => string | DevExpress.core.UserDefinedElement); /** * */ menuItemTemplate?: | template | (() => string | DevExpress.core.UserDefinedElement); } /** * The FileUploader UI component enables an end user to upload files to the server. An end user can select files in the file explorer or drag and drop files to the FileUploader area on the page. */ export class dxFileUploader extends Editor { /** * Uploads all the selected files. */ upload(): void; /** * Uploads a file with the specified index. */ upload(fileIndex: number): void; /** * Uploads the specified file. */ upload(file: File): void; /** * Cancels the file upload. */ abortUpload(): void; /** * Cancels the file upload. */ abortUpload(fileIndex: number): void; /** * Cancels the file upload. */ abortUpload(file: File): void; /** * Removes a file with the specified index. */ removeFile(fileIndex: number): void; /** * Removes a file. */ removeFile(file: File): void; /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxFileUploader.Properties['value']): void; } module dxFileUploader { /** * The type of the beforeSend event handler's argument. */ export type BeforeSendEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly request: XMLHttpRequest; /** * */ readonly file: File; /** * */ readonly uploadInfo?: DevExpress.fileManagement.UploadInfo; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the dropZoneEnter event handler's argument. */ export type DropZoneEnterEvent = DevExpress.common.core.events.NativeEventInfo< dxFileUploader, PointerEvent | MouseEvent > & { /** * */ readonly dropZoneElement: DevExpress.core.DxElement; }; /** * The type of the dropZoneLeave event handler's argument. */ export type DropZoneLeaveEvent = DevExpress.common.core.events.NativeEventInfo< dxFileUploader, PointerEvent | MouseEvent > & { /** * */ readonly dropZoneElement: DevExpress.core.DxElement; }; /** * The type of the filesUploaded event handler's argument. */ export type FilesUploadedEvent = DevExpress.common.core.events.EventInfo; export type FileUploadMode = 'instantly' | 'useButtons' | 'useForm'; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the progress event handler's argument. */ export type ProgressEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly file: File; /** * */ readonly segmentSize: number; /** * */ readonly bytesLoaded: number; /** * */ readonly bytesTotal: number; /** * */ readonly request: XMLHttpRequest; }; export type Properties = dxFileUploaderOptions; /** * The type of the uploadAborted event handler's argument. */ export type UploadAbortedEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly file: File; /** * */ readonly request: XMLHttpRequest; /** * */ message: string; }; /** * The type of the uploaded event handler's argument. */ export type UploadedEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly file: File; /** * */ readonly request: XMLHttpRequest; /** * */ message: string; }; /** * The type of the uploadError event handler's argument. */ export type UploadErrorEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly file: File; /** * */ readonly request: XMLHttpRequest; /** * */ readonly error: any; /** * */ message: string; }; export type UploadHttpMethod = 'POST' | 'PUT'; /** * The type of the uploadStarted event handler's argument. */ export type UploadStartedEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly file: File; /** * */ readonly request: XMLHttpRequest; }; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo & { /** * */ readonly value?: Array; /** * */ readonly previousValue?: Array; }; } /** * * @deprecated * @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 dxFileUploaderOptions extends EditorOptions { /** * A function that cancels the file upload. */ abortUpload?: ( file: File, uploadInfo?: DevExpress.fileManagement.UploadInfo ) => PromiseLike | any; /** * Specifies file types users can select in the Open File dialog. The default value accepts all file types. */ accept?: string; /** * Specifies if an end user can remove a file from the selection and interrupt uploading. */ allowCanceling?: boolean; /** * Restricts file extensions that can be uploaded to the server. */ allowedFileExtensions?: Array; /** * Specifies the chunk size in bytes. Applies only if uploadMode is 'instantly' or 'useButtons'. Requires a server that can process file chunks. */ chunkSize?: number; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the FileUploader component changes the state of all its buttons when users hover over them. */ hoverStateEnabled?: boolean; /** * The text displayed when the extension of the file being uploaded is not an allowed file extension. */ invalidFileExtensionMessage?: string; /** * The text displayed when the size of the file being uploaded is greater than the maxFileSize. */ invalidMaxFileSizeMessage?: string; /** * The text displayed when the size of the file being uploaded is less than the minFileSize. */ invalidMinFileSizeMessage?: string; /** * Specifies the attributes to be passed on to the underlying `` element of the `file` type. */ inputAttr?: any; /** * Specifies the text displayed on the area to which an end user can drop a file. */ labelText?: string; /** * Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. */ maxFileSize?: number; /** * Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is 'instantly' or 'useButtons'. */ minFileSize?: number; /** * Specifies whether the UI component enables an end user to select a single file or multiple files. */ multiple?: boolean; /** * Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server. */ name?: string; /** * A function that allows you to customize the request before it is sent to the server. */ onBeforeSend?: (e: DevExpress.ui.dxFileUploader.BeforeSendEvent) => void; /** * A function that is executed when the mouse enters a drop zone while dragging a file. */ onDropZoneEnter?: ( e: DevExpress.ui.dxFileUploader.DropZoneEnterEvent ) => void; /** * A function that is executed when the mouse leaves a drop zone as it drags a file. */ onDropZoneLeave?: ( e: DevExpress.ui.dxFileUploader.DropZoneLeaveEvent ) => void; /** * A function that is executed when the file upload process is complete. */ onFilesUploaded?: ( e: DevExpress.ui.dxFileUploader.FilesUploadedEvent ) => void; /** * A function that is executed when a file segment is uploaded. */ onProgress?: (e: DevExpress.ui.dxFileUploader.ProgressEvent) => void; /** * A function that is executed when the file upload is aborted. */ onUploadAborted?: ( e: DevExpress.ui.dxFileUploader.UploadAbortedEvent ) => void; /** * A function that is executed when an error occurs during the file upload. */ onUploadError?: (e: DevExpress.ui.dxFileUploader.UploadErrorEvent) => void; /** * A function that is executed when the file upload is started. */ onUploadStarted?: ( e: DevExpress.ui.dxFileUploader.UploadStartedEvent ) => void; /** * A function that is executed when a file is successfully uploaded. */ onUploaded?: (e: DevExpress.ui.dxFileUploader.UploadedEvent) => void; /** * A function that is executed when one or several files are added to or removed from the selection. */ onValueChanged?: ( e: DevExpress.ui.dxFileUploader.ValueChangedEvent ) => void; /** * Gets the current progress in percentages. */ progress?: number; /** * The message displayed by the UI component when it is ready to upload the specified files. */ readyToUploadMessage?: string; /** * The text displayed on the button that opens the file browser. */ selectButtonText?: string; /** * Specifies whether or not the UI component displays the list of selected files. */ showFileList?: boolean; /** * Specifies the HTML element which invokes the file upload dialog. */ dialogTrigger?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies the HTML element in which users can drag and drop files for upload. */ dropZone?: string | DevExpress.core.UserDefinedElement | undefined; /** * The text displayed on the button that starts uploading. */ uploadButtonText?: string; /** * A function that uploads a file in chunks. */ uploadChunk?: ( file: File, uploadInfo: DevExpress.fileManagement.UploadInfo ) => PromiseLike | any; /** * The message displayed by the UI component on uploading failure. */ uploadFailedMessage?: string; /** * The message displayed by the UI component when the file upload is cancelled. */ uploadAbortedMessage?: string; /** * A function that uploads a file. */ uploadFile?: ( file: File, progressCallback: Function ) => PromiseLike | any; /** * Specifies headers for the upload request. */ uploadHeaders?: any; /** * Specifies custom data for the upload request. */ uploadCustomData?: any; /** * Specifies the method for the upload request. */ uploadMethod?: DevExpress.ui.dxFileUploader.UploadHttpMethod; /** * Specifies how the UI component uploads files. */ uploadMode?: DevExpress.ui.dxFileUploader.FileUploadMode; /** * Specifies a target Url for the upload request. */ uploadUrl?: string; /** * The message displayed by the UI component when uploading is finished. */ uploadedMessage?: string; /** * Specifies a File instance representing the selected file. Read-only when uploadMode is 'useForm'. */ value?: Array; } /** * The FilterBuilder UI component allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI. */ export class dxFilterBuilder extends Widget { /** * Gets a filter expression that contains only operations supported by the DataSource. */ getFilterExpression(): string | Array | Function; } module dxFilterBuilder { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; export type CustomOperation = dxFilterBuilderCustomOperation; export type CustomOperationEditorTemplate = { readonly value?: string | number | Date; readonly field: Field; readonly setValue: Function; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the editorPrepared event handler's argument. */ export type EditorPreparedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly value?: any; /** * */ readonly setValue: any; /** * */ readonly editorElement: DevExpress.core.DxElement; /** * */ readonly editorName: string; /** * */ readonly dataField?: string; /** * */ readonly filterOperation?: string; /** * */ readonly updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly readOnly: boolean; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; }; /** * The type of the editorPreparing event handler's argument. */ export type EditorPreparingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly value?: any; /** * */ readonly setValue: any; /** * */ readonly editorElement?: DevExpress.core.DxElement; /** * */ editorName: string; /** * */ editorOptions?: any; /** * */ readonly dataField?: string; /** * */ readonly filterOperation?: string; /** * */ updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly readOnly: boolean; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; }; export type FieldEditorTemplate = { readonly value?: string | number | Date; readonly filterOperation?: string; readonly field: Field; readonly setValue: Function; }; /** * Information about a FilterBuilder field. */ export type FieldInfo = { /** * Unformatted field value (set in the editor). */ value?: string | number | Date; /** * The value with the format applied. */ valueText?: string; /** * Field configuration. */ field?: Field; }; /** * @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 FilterBuilderOperation = | '=' | '<>' | '<' | '<=' | '>' | '>=' | 'contains' | 'endswith' | 'isblank' | 'isnotblank' | 'notcontains' | 'startswith' | 'between'; /** * @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 FilterLookupDataSource = Exclude< DevExpress.data.DataSourceLike, string | DevExpress.common.data.DataSource >; export type GroupOperation = 'and' | 'or' | 'notAnd' | 'notOr'; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxFilterBuilderOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly value?: any; /** * */ readonly previousValue?: any; }; } /** * @deprecated Use the CustomOperation type instead * @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 dxFilterBuilderCustomOperation { /** * Specifies a function that returns a filter expression for this custom operation. */ calculateFilterExpression?: ( filterValue: any, field: Field ) => string | Array | Function; /** * Specifies the operation's caption. */ caption?: string | undefined; /** * Customizes the field value's text representation. */ customizeText?: ( fieldInfo: DevExpress.ui.dxFilterBuilder.FieldInfo ) => string; /** * Specifies for which data types the operation is available by default. */ dataTypes?: Array | undefined; /** * Specifies a custom template for the UI component used to edit the field value. */ editorTemplate?: | template | (( conditionInfo: DevExpress.ui.dxFilterBuilder.CustomOperationEditorTemplate, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether the operation can have a value. If it can, the editor is displayed. */ hasValue?: boolean; /** * Specifies the icon that should represent the filter operation. */ icon?: string | undefined; /** * Specifies the operation's identifier. */ name?: string | undefined; } /** * @deprecated Use the Field type instead * @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 dxFilterBuilderField { /** * Specifies the field's custom rules to filter data. */ calculateFilterExpression?: ( filterValue: any, selectedFilterOperation: string ) => string | Array | Function; /** * Specifies the data field's caption. */ caption?: string | undefined; /** * Customizes the input value's display text. */ customizeText?: ( fieldInfo: DevExpress.ui.dxFilterBuilder.FieldInfo ) => string; /** * Specifies the name of a field to be filtered. */ dataField?: string | undefined; /** * Casts field values to a specific data type. */ dataType?: DevExpress.common.DataType; /** * Configures the UI component used to edit the field value. */ editorOptions?: any; /** * Specifies the editor's custom template. */ editorTemplate?: | template | (( conditionInfo: DevExpress.ui.dxFilterBuilder.FieldEditorTemplate, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the false value text. Applies only if dataType is 'boolean'. */ falseText?: string; /** * Specifies a set of available filter operations. */ filterOperations?: Array< DevExpress.ui.dxFilterBuilder.FilterBuilderOperation | string >; /** * Formats a value before it is displayed. */ format?: DevExpress.common.core.localization.Format; /** * Configures the lookup field. */ lookup?: { /** * Specifies whether to display the Clear button in the lookup field while it is being edited. */ allowClearing?: boolean; /** * Specifies the lookup data source. */ dataSource?: | DevExpress.ui.dxFilterBuilder.FilterLookupDataSource | null | undefined; /** * Specifies the data field whose values should be displayed. */ displayExpr?: string | ((data: any) => string) | undefined; /** * Specifies the data field whose values should be replaced with values from the displayExpr field. */ valueExpr?: | string | ((data: any) => string | number | boolean) | undefined; }; /** * Specifies the field's name. Use it to distinguish the field from other fields when they have identical dataField values. */ name?: string | undefined; /** * Specifies the true value text. Applies only if dataType is 'boolean'. */ trueText?: string; } /** * * @deprecated * @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 dxFilterBuilderOptions extends WidgetOptions { /** * Specifies whether the UI component can display hierarchical data fields. */ allowHierarchicalFields?: boolean; /** * Configures custom filter operations. */ customOperations?: Array; /** * Configures fields. */ fields?: Array; /** * Specifies filter operation descriptions. */ filterOperationDescriptions?: { /** * The 'between' operation's description. */ between?: string; /** * The 'contains' operation's description. */ contains?: string; /** * The 'endswith' operation's description. */ endsWith?: string; /** * The '=' operation's description. */ equal?: string; /** * The '>' operation's description. */ greaterThan?: string; /** * The '>=' operation's description. */ greaterThanOrEqual?: string; /** * The 'isblank' operation's description. */ isBlank?: string; /** * The 'isnotblank' operation's description. */ isNotBlank?: string; /** * The '<' operation's description. */ lessThan?: string; /** * The '<=' operation's description. */ lessThanOrEqual?: string; /** * The 'notcontains' operation's description. */ notContains?: string; /** * The '<>' operation's description. */ notEqual?: string; /** * The 'startswith' operation's description. */ startsWith?: string; }; /** * Specifies group operation descriptions. */ groupOperationDescriptions?: { /** * The 'and' operation's description. */ and?: string; /** * The 'notand' operation's description. */ notAnd?: string; /** * The 'notor' operation's description. */ notOr?: string; /** * The 'or' operation's description. */ or?: string; }; /** * Specifies a set of available group operations. */ groupOperations?: Array; /** * Specifies groups' maximum nesting level. */ maxGroupLevel?: number | undefined; /** * A function that is executed after an editor is created. */ onEditorPrepared?: ( e: DevExpress.ui.dxFilterBuilder.EditorPreparedEvent ) => void; /** * A function that is executed before an editor is created. */ onEditorPreparing?: ( e: DevExpress.ui.dxFilterBuilder.EditorPreparingEvent ) => void; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: ( e: DevExpress.ui.dxFilterBuilder.ValueChangedEvent ) => void; /** * Allows you to specify a filter. */ value?: string | Array | Function; } /** * The Form UI component represents fields of a data object as a collection of label-editor pairs. These pairs can be arranged in several groups, tabs and columns. */ export class dxForm extends Widget { /** * Gets a button's instance. */ getButton(name: string): dxButton | undefined; /** * Gets an editor instance. Takes effect only if the form item is visible. */ getEditor(dataField: string): Editor | undefined; /** * Gets a form item's configuration. */ itemOption(id: string): any; /** * Updates the value of a single item option. */ itemOption(id: string, option: string, value: any): void; /** * Updates the values of several item properties. */ itemOption(id: string, options: any): void; /** * Resets editor values to their default values. */ clear(): void; /** * Resets the editor's value to undefined. * @deprecated Use the clear() method instead. */ resetValues(): void; /** * Resets editor values. Every editor attempts to obtain its new value from the argument list. If an editor is not included in the list, that editor resets to its initial value. */ reset(editorsData?: Record): void; /** * Merges the passed `data` object with formData. Matching properties in formData are overwritten and new properties added. */ updateData(data: any): void; /** * Updates a formData field and the corresponding editor. */ updateData(dataField: string, value: any): void; /** * Updates the dimensions of the UI component contents. */ updateDimensions(): DevExpress.core.utils.DxPromise; /** * Validates the values of all editors on the form against the list of the validation rules specified for each form item. */ validate(): DevExpress.ui.dxValidationGroup.ValidationResult; } module dxForm { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the editorEnterKey event handler's argument. */ export type EditorEnterKeyEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly dataField?: string; }; /** * The type of the fieldDataChanged event handler's argument. */ export type FieldDataChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly dataField?: string; /** * */ readonly value?: any; }; export type FormItemComponent = | 'dxAutocomplete' | 'dxCalendar' | 'dxCheckBox' | 'dxColorBox' | 'dxDateBox' | 'dxDateRangeBox' | 'dxDropDownBox' | 'dxHtmlEditor' | 'dxLookup' | 'dxNumberBox' | 'dxRadioGroup' | 'dxRangeSlider' | 'dxSelectBox' | 'dxSlider' | 'dxSwitch' | 'dxTagBox' | 'dxTextArea' | 'dxTextBox'; export type FormItemType = | 'empty' | 'group' | 'simple' | 'tabbed' | 'button'; export type FormLabelMode = 'static' | 'floating' | 'hidden' | 'outside'; export type GroupCaptionTemplateData = { readonly caption?: string; readonly component: dxForm; readonly name?: string; }; export type GroupItemTemplateData = { readonly component: dxForm; readonly formData?: any; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; export type LabelLocation = 'left' | 'right' | 'top'; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxFormOptions; export type SimpleItemLabelTemplateData = SimpleItemTemplateData & { text: string; }; export type SimpleItemTemplateData = { readonly component: dxForm; readonly dataField?: string; readonly editorOptions?: any; readonly editorType?: string; readonly name?: string; }; } /** * @deprecated Use ButtonItem instead * @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 dxFormButtonItem { /** * Configures the button. */ buttonOptions?: dxButtonOptions | undefined; /** * Specifies how many columns the item spans. */ colSpan?: number | undefined; /** * Specifies a CSS class to be applied to the item. */ cssClass?: string | undefined; /** * Specifies the button's horizontal alignment. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Specifies the item's type. Set it to 'button' to create a button item. */ itemType?: DevExpress.ui.dxForm.FormItemType; /** * Specifies the item's identifier. */ name?: string | undefined; /** * Specifies the button's vertical alignment. */ verticalAlignment?: DevExpress.common.VerticalAlignment; /** * Specifies whether the item is visible. */ visible?: boolean; /** * Specifies the item's position regarding other items in a group, tab, or the whole UI component. */ visibleIndex?: number | undefined; } /** * @deprecated Use EmptyItem instead * @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 dxFormEmptyItem { /** * Specifies the number of columns spanned by the item. */ colSpan?: number | undefined; /** * Specifies a CSS class to be applied to the form item. */ cssClass?: string | undefined; /** * Specifies the item's type. Set it to 'empty' to create an empty item. */ itemType?: DevExpress.ui.dxForm.FormItemType; /** * Specifies a name that identifies the form item. */ name?: string | undefined; /** * Specifies whether or not the current form item is visible. */ visible?: boolean; /** * Specifies the sequence number of the item in a form, group or tab. */ visibleIndex?: number | undefined; } /** * @deprecated Use GroupItem instead * @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 dxFormGroupItem { /** * Specifies whether or not all group item labels are aligned. */ alignItemLabels?: boolean; /** * Specifies the group caption. */ caption?: string | undefined; /** * Specifies a template that can be used to replace group captions with custom content. */ captionTemplate?: | template | (( data: DevExpress.ui.dxForm.GroupCaptionTemplateData, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * The count of columns in the group layout. */ colCount?: number; /** * Specifies the relation between the screen size qualifier and the number of columns in the grouped layout. */ colCountByScreen?: any | undefined; /** * Specifies the number of columns spanned by the item. */ colSpan?: number | undefined; /** * Specifies a CSS class to be applied to the form item. */ cssClass?: string | undefined; /** * Specifies the item's type. Set it to 'group' to create a group item. */ itemType?: DevExpress.ui.dxForm.FormItemType; /** * Holds an array of form items displayed within the group. */ items?: Array | undefined; /** * Specifies a name that identifies the form item. */ name?: string | undefined; /** * A template to be used for rendering a group item. */ template?: | template | (( data: DevExpress.ui.dxForm.GroupItemTemplateData, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether or not the current form item is visible. */ visible?: boolean; /** * Specifies the sequence number of the item in a form, group or tab. */ visibleIndex?: number | undefined; } /** * * @deprecated * @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 dxFormOptions extends WidgetOptions { /** * Specifies whether all item labels are aligned. Applies only to labels outside their editors (see labelMode). */ alignItemLabels?: boolean; /** * Specifies whether item labels in all groups are aligned. Applies only to labels outside their editors (see labelMode). */ alignItemLabelsInAllGroups?: boolean; /** * The count of columns in the form layout. */ colCount?: number | DevExpress.common.Mode; /** * Specifies dependency between the screen factor and the count of columns in the form layout. */ colCountByScreen?: any | undefined; /** * Specifies a function that customizes a form item after it has been created. */ customizeItem?: (item: DevExpress.ui.dxForm.Item) => void; /** * Provides the Form's data. Gets updated every time form fields change. */ formData?: any; /** * Holds an array of form items. */ items?: Array | undefined; /** * Specifies the location of a label against the editor. Applies only to labels outside their editors (see labelMode). */ labelLocation?: DevExpress.ui.dxForm.LabelLocation; /** * Specifies a display mode for item labels. */ labelMode?: DevExpress.ui.dxForm.FormLabelMode; /** * The minimum column width used for calculating column count in the form layout. Applies only if colCount property is 'auto'. */ minColWidth?: number; /** * A function that is executed when the Enter key has been pressed while an editor is focused. */ onEditorEnterKey?: (e: DevExpress.ui.dxForm.EditorEnterKeyEvent) => void; /** * A function that is executed when the value of a formData object field is changed. */ onFieldDataChanged?: ( e: DevExpress.ui.dxForm.FieldDataChangedEvent ) => void; /** * The text displayed for optional fields. Applies only if showOptionalMark is true. */ optionalMark?: string; /** * Specifies whether all editors on the form are read-only. Applies only to non-templated items. */ readOnly?: boolean; /** * The text displayed for required fields. */ requiredMark?: string; /** * Specifies the message that is shown for end-users if a required field value is not specified. */ requiredMessage?: string; /** * Specifies a function that categorizes screens by their width. */ screenByWidth?: Function; /** * A Boolean value specifying whether to enable or disable form scrolling. */ scrollingEnabled?: boolean; /** * Specifies whether a colon is displayed at the end of form labels. Applies only to labels outside their editors (see labelMode). */ showColonAfterLabel?: boolean; /** * Specifies whether or not the optional mark is displayed for optional fields. */ showOptionalMark?: boolean; /** * Specifies whether or not the required mark is displayed for required fields. */ showRequiredMark?: boolean; /** * Specifies whether or not the total validation summary is displayed on the form. */ showValidationSummary?: boolean; /** * Gives a name to the internal validation group. */ validationGroup?: string | undefined; /** * Specifies whether current editor values differ from initial values. */ readonly isDirty?: boolean; } /** * @deprecated Use SimpleItem instead * @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 dxFormSimpleItem { /** * Specifies the number of columns spanned by the item. */ colSpan?: number | undefined; /** * Specifies a CSS class to be applied to the form item. */ cssClass?: string | undefined; /** * Specifies the path to the formData object field bound to the current form item. */ dataField?: string | undefined; /** * Configures the form item's editor. */ editorOptions?: any | undefined; /** * Specifies which editor UI component is used to display and edit the form item value. */ editorType?: DevExpress.ui.dxForm.FormItemComponent; /** * Specifies the help text displayed for the current form item. */ helpText?: string | undefined; /** * Specifies if the current form item is required. */ isRequired?: boolean | undefined; /** * Specifies the item's type. Set it to 'simple' to create a simple item. */ itemType?: DevExpress.ui.dxForm.FormItemType; /** * Specifies properties for the form item label. */ label?: { /** * Specifies the label's horizontal alignment. Applies only to labels outside their editors (see labelMode). */ alignment?: DevExpress.common.HorizontalAlignment; /** * Specifies the location of a label against the editor. Applies only to labels outside their editors (see labelMode). */ location?: DevExpress.ui.dxForm.LabelLocation; /** * Specifies whether a colon is displayed at the end of the current label. Applies only to labels outside their editors (see labelMode). */ showColon?: boolean; /** * A template that can be used to replace the label with custom content. Applies only to labels outside their editors (see labelMode). */ template?: | template | (( itemData: DevExpress.ui.dxForm.SimpleItemLabelTemplateData, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the label text. */ text?: string | undefined; /** * Controls the visibility of the label outside the editor. */ visible?: boolean; }; /** * Specifies a name that identifies the form item. */ name?: string | undefined; /** * A template that can be used to replace the default editor with custom content. */ template?: | template | (( data: DevExpress.ui.dxForm.SimpleItemTemplateData, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * An array of validation rules to be checked for the form item editor. */ validationRules?: Array< | DevExpress.common.RequiredRule | DevExpress.common.NumericRule | DevExpress.common.RangeRule | DevExpress.common.StringLengthRule | DevExpress.common.CustomRule | DevExpress.common.CompareRule | DevExpress.common.PatternRule | DevExpress.common.EmailRule | DevExpress.common.AsyncRule >; /** * Specifies whether or not the current form item is visible. */ visible?: boolean; /** * Specifies the sequence number of the item in a form, group or tab. */ visibleIndex?: number | undefined; } /** * @deprecated Use TabbedItem instead * @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 dxFormTabbedItem { /** * Specifies the number of columns spanned by the item. */ colSpan?: number | undefined; /** * Specifies a CSS class to be applied to the form item. */ cssClass?: string | undefined; /** * Specifies the item's type. Set it to 'tabbed' to create a tabbed item. */ itemType?: DevExpress.ui.dxForm.FormItemType; /** * Specifies a name that identifies the form item. */ name?: string | undefined; /** * Holds a configuration object for the TabPanel UI component used to display the current form item. */ tabPanelOptions?: dxTabPanelOptions | undefined; /** * An array of tab configuration objects. */ tabs?: Array<{ /** * Specifies whether or not labels of items displayed within the current tab are aligned. */ alignItemLabels?: boolean; /** * Specifies a badge text for the tab. */ badge?: string | undefined; /** * The count of columns in the tab layout. */ colCount?: number; /** * Specifies the relation between the screen size qualifier and the number of columns in the tabbed layout. */ colCountByScreen?: any | undefined; /** * Specifies whether the tab responds to user interaction. */ disabled?: boolean; /** * Specifies the icon to be displayed on the tab. */ icon?: string | undefined; /** * Holds an array of form items displayed within the tab. */ items?: Array | undefined; /** * The template to be used for rendering the tab. */ tabTemplate?: | template | (( tabData: any, tabIndex: number, tabElement: DevExpress.core.DxElement ) => any) | undefined; /** * The template to be used for rendering the tab content. */ template?: | template | (( tabData: any, tabIndex: number, tabElement: DevExpress.core.DxElement ) => any) | undefined; /** * Specifies the tab title. */ title?: string | undefined; }>; /** * Specifies whether or not the current form item is visible. */ visible?: boolean; /** * Specifies the sequence number of the item in a form, group or tab. */ visibleIndex?: number | undefined; } /** * The Gallery is a UI component that displays a collection of images in a carousel. The UI component is supplied with various navigation controls that allow a user to switch between images. */ export class dxGallery< TItem extends DevExpress.ui.dxGallery.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> { /** * Shows a specific image. */ goToItem( itemIndex: number, animation: boolean ): DevExpress.core.utils.DxPromise; /** * Shows the next image. */ nextItem(animation: boolean): DevExpress.core.utils.DxPromise; /** * Shows the previous image. */ prevItem(animation: boolean): DevExpress.core.utils.DxPromise; } module dxGallery { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxGallery >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxGallery, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxGallery, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxGallery, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxGalleryOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; } /** * @deprecated Use Item instead * @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 dxGalleryItem extends CollectionWidgetItem { /** * Specifies the text passed to the alt attribute of the image markup element. */ imageAlt?: string; /** * Specifies the URL of the image displayed by the item. */ imageSrc?: string; } /** * * @deprecated */ export interface dxGalleryOptions< TItem extends DevExpress.ui.dxGallery.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * The time, in milliseconds, spent on slide animation. */ animationDuration?: number; /** * Specifies whether or not to animate the displayed item change. */ animationEnabled?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. */ indicatorEnabled?: boolean; /** * Specifies the width of an area used to display a single image. */ initialItemWidth?: number | undefined; /** * An array of items displayed by the UI component. */ items?: Array; /** * A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ loop?: boolean; /** * Specifies the text or HTML markup displayed by the UI component if the item collection is empty. */ noDataText?: string; /** * The index of the currently active gallery item. */ selectedIndex?: number; /** * A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. */ showIndicator?: boolean; /** * A Boolean value that specifies the availability of the 'Forward' and 'Back' navigation buttons. */ showNavButtons?: boolean; /** * The time interval in milliseconds, after which the gallery switches to the next item. */ slideshowDelay?: number; /** * Specifies if the UI component stretches images to fit the total gallery width. */ stretchImages?: boolean; /** * A Boolean value specifying whether or not to allow users to switch between items by swiping. */ swipeEnabled?: boolean; /** * Specifies whether or not to display parts of previous and next images along the sides of the current image. */ wrapAround?: boolean; } /** * The Gantt is a UI component that displays the task flow and dependencies between tasks. */ export class dxGantt extends Widget { /** * Gets the task data. */ getTaskData(key: any): any; /** * Gets the dependency data. */ getDependencyData(key: any): any; /** * Gets the resource data. */ getResourceData(key: any): any; /** * Gets the resource assignment data. */ getResourceAssignmentData(key: any): any; /** * Inserts a new task. */ insertTask(data: any): void; /** * Deletes a task. */ deleteTask(key: any): void; /** * Updates the task data. */ updateTask(key: any, data: any): void; /** * Inserts a new dependency. */ insertDependency(data: any): void; /** * Deletes a dependency. */ deleteDependency(key: any): void; /** * Inserts a new resource. */ insertResource(data: any, taskKeys?: Array): void; /** * Deletes a resource. */ deleteResource(key: any): void; /** * Assigns a resource to a task. */ assignResourceToTask(resourceKey: any, taskKey: any): void; /** * Removes a resource from the task. */ unassignResourceFromTask(resourceKey: any, taskKey: any): void; /** * Gets resources assigned to a task. */ getTaskResources(key: any): Array; /** * Gets the keys of the visible tasks. */ getVisibleTaskKeys(): Array; /** * Gets the keys of the visible dependencies. */ getVisibleDependencyKeys(): Array; /** * Gets the keys of the visible resources. */ getVisibleResourceKeys(): Array; /** * Gets the keys of the visible resource assignments. */ getVisibleResourceAssignmentKeys(): Array; /** * Updates the dimensions of the UI component contents. */ updateDimensions(): void; /** * Scrolls the Gantt chart to the specified date. */ scrollToDate(date: Date | Number | string): void; /** * Invokes the 'Resource Manager' dialog. */ showResourceManagerDialog(): void; /** * Expands all tasks. */ expandAll(): void; /** * Collapses all tasks. */ collapseAll(): void; /** * Expands all tasks down to the specified hierarchical level. */ expandAllToLevel(level: Number): void; /** * Expands a task's parent tasks. */ expandToTask(key: any): void; /** * Collapses a task. */ collapseTask(key: any): void; /** * Expands a task. */ expandTask(key: any): void; /** * Reloads data and repaints the Gantt component. */ refresh(): DevExpress.core.utils.DxPromise; /** * Shows or hides task resources. */ showResources(value: boolean): void; /** * Shows or hides dependencies between tasks. */ showDependencies(value: boolean): void; /** * Zooms in the Gantt chart. */ zoomIn(): void; /** * Zooms out the Gantt chart. */ zoomOut(): void; /** * Removes all resources from the task. */ unassignAllResourcesFromTask(taskKey: any): void; /** * Invokes the 'Task Details' dialog. */ showTaskDetailsDialog(taskKey: any): void; } module dxGantt { export type Column = dxGanttColumn< TRowData, TKey >; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contextMenuPreparing event handler's argument. */ export type ContextMenuPreparingEvent = DevExpress.common.core.events.Cancelable & { /** * */ readonly component?: dxGantt; /** * */ readonly element?: DevExpress.core.DxElement; /** * */ readonly event?: DevExpress.events.DxEvent; /** * */ readonly targetKey?: any; /** * */ readonly targetType?: string; /** * */ readonly data?: any; /** * */ readonly items?: Array; }; /** * The type of the customCommand event handler's argument. */ export type CustomCommandEvent = { /** * */ readonly component?: dxGantt; /** * */ readonly element?: DevExpress.core.DxElement; /** * */ readonly name: string; }; /** * The type of the dependencyDeleted event handler's argument. */ export type DependencyDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the dependencyDeleting event handler's argument. */ export type DependencyDeletingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the dependencyInserted event handler's argument. */ export type DependencyInsertedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the dependencyInserting event handler's argument. */ export type DependencyInsertingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * @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 GanttPdfExportDateRange = 'all' | 'visible'; /** * @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 GanttPdfExportMode = 'all' | 'treeList' | 'chart'; export type GanttPredefinedContextMenuItem = | 'undo' | 'redo' | 'expandAll' | 'collapseAll' | 'addTask' | 'deleteTask' | 'zoomIn' | 'zoomOut' | 'deleteDependency' | 'taskDetails' | 'resourceManager'; export type GanttPredefinedToolbarItem = | 'separator' | 'undo' | 'redo' | 'expandAll' | 'collapseAll' | 'addTask' | 'deleteTask' | 'zoomIn' | 'zoomOut' | 'taskDetails' | 'fullScreen' | 'resourceManager' | 'showResources' | 'showDependencies'; /** * @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 GanttRenderScaleType = | 'minutes' | 'hours' | 'sixHours' | 'days' | 'weeks' | 'months' | 'quarters' | 'years' | 'fiveYears'; /** * @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 GanttScaleType = | 'auto' | 'minutes' | 'hours' | 'sixHours' | 'days' | 'weeks' | 'months' | 'quarters' | 'years'; /** * @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 GanttTaskTitlePosition = 'inside' | 'outside' | 'none'; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type ProgressTooltipTemplateData = { readonly progress: number; }; export type Properties = dxGanttOptions; /** * The type of the resourceAssigned event handler's argument. */ export type ResourceAssignedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the resourceAssigning event handler's argument. */ export type ResourceAssigningEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; }; /** * The type of the resourceDeleted event handler's argument. */ export type ResourceDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the resourceDeleting event handler's argument. */ export type ResourceDeletingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the resourceInserted event handler's argument. */ export type ResourceInsertedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the resourceInserting event handler's argument. */ export type ResourceInsertingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; }; /** * The type of the resourceManagerDialogShowing event handler's argument. */ export type ResourceManagerDialogShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: Array; }; /** * The type of the resourceUnassigned event handler's argument. */ export type ResourceUnassignedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the resourceUnassigning event handler's argument. */ export type ResourceUnassigningEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the scaleCellPrepared event handler's argument. */ export type ScaleCellPreparedEvent = DevExpress.common.core.events.InitializedEventInfo & { /** * */ readonly scaleIndex: number; /** * */ readonly scaleType: GanttRenderScaleType; /** * */ readonly scaleElement: DevExpress.core.DxElement; /** * */ readonly separatorElement: DevExpress.core.DxElement; /** * */ readonly startDate: Date; /** * */ readonly endDate: Date; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly selectedRowKey?: any; }; /** * The type of the taskClick event handler's argument. */ export type TaskClickEvent = DevExpress.common.core.events.NativeEventInfo< dxGantt, PointerEvent | MouseEvent > & { /** * */ readonly key?: any; /** * */ readonly data?: any; }; export type TaskContentTemplateData = { readonly cellSize: any; readonly isMilestone: boolean; readonly taskData: any; readonly taskHTML: any; readonly taskPosition: any; readonly taskResources: Array; readonly taskSize: any; }; /** * The type of the taskDblClick event handler's argument. */ export type TaskDblClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxGantt, PointerEvent | MouseEvent > & { /** * */ readonly key?: any; /** * */ readonly data?: any; }; /** * The type of the taskDeleted event handler's argument. */ export type TaskDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the taskDeleting event handler's argument. */ export type TaskDeletingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the taskEditDialogShowing event handler's argument. */ export type TaskEditDialogShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; /** * */ readonly readOnlyFields?: Array; /** * */ readonly hiddenFields?: Array; }; /** * The type of the taskInserted event handler's argument. */ export type TaskInsertedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values?: any; /** * */ readonly key: any; }; /** * The type of the taskInserting event handler's argument. */ export type TaskInsertingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; }; /** * The type of the taskMoving event handler's argument. */ export type TaskMovingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly newValues: any; /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the taskUpdated event handler's argument. */ export type TaskUpdatedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly values: any; /** * */ readonly key: any; }; /** * The type of the taskUpdating event handler's argument. */ export type TaskUpdatingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly newValues: any; /** * */ readonly values: any; /** * */ readonly key: any; }; export type TimeTooltipTemplateData = { readonly start: Date; readonly end: Date; }; } /** * @deprecated Use the Column type instead * @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 dxGanttColumn = Omit< dxGanttColumnBlank, | 'allowEditing' | 'allowFixing' | 'allowHiding' | 'allowReordering' | 'allowResizing' | 'allowSearch' | 'buttons' | 'columns' | 'editCellTemplate' | 'editorOptions' | 'fixed' | 'fixedPosition' | 'formItem' | 'hidingPriority' | 'isBand' | 'lookup' | 'name' | 'ownerBand' | 'renderAsync' | 'setCellValue' | 'showEditorAlways' | 'showInColumnChooser' | 'type' | 'validationRules' >; /** * Configures the column. * @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 dxGanttColumnBlank extends DevExpress.ui.dxTreeList.Column { /** * */ allowEditing: any; /** * */ allowFixing: any; /** * */ allowHiding: any; /** * */ allowReordering: any; /** * */ allowResizing: any; /** * */ allowSearch: any; /** * */ buttons: any; /** * */ columns: any; /** * */ editorOptions: any; /** * */ editCellTemplate: any; /** * */ fixed: any; /** * */ fixedPosition: any; /** * */ formItem: any; /** * */ hidingPriority: any; /** * */ isBand: any; /** * */ lookup: any; /** * */ name: any; /** * */ ownerBand: any; /** * */ renderAsync: any; /** * */ setCellValue: any; /** * */ showEditorAlways: any; /** * */ showInColumnChooser: any; /** * */ validationRules: any; /** * */ type: any; } /** * Configures the context menu. * @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 dxGanttContextMenu { /** * Specifies whether the context menu is enabled in the UI component. */ enabled?: boolean; /** * Configures context menu item settings. */ items?: Array< | DevExpress.ui.dxGantt.ContextMenuItem | DevExpress.ui.dxGantt.GanttPredefinedContextMenuItem >; } /** * @deprecated Use ContextMenuItem instead * @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 dxGanttContextMenuItem extends DevExpress.ui.dxContextMenu.Item { /** * Specifies the context menu item name. */ name?: DevExpress.ui.dxGantt.GanttPredefinedContextMenuItem | string; } /** * Configures the filter row. * @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 dxGanttFilterRow { /** * Specifies the null text for the editor that sets the end of a range for the 'between' filter operation. */ betweenEndText?: string; /** * Specifies the null text for the editor that sets the start of a range for the 'between' filter operation. */ betweenStartText?: string; /** * Specifies descriptions for filter operations in the filter list. */ operationDescriptions?: dxGanttFilterRowOperationDescriptions; /** * Specifies text for the 'reset' operation. */ resetOperationText?: string; /** * Specifies text for the 'All' filter operation. */ showAllText?: string; /** * Specifies whether to display filter icons. */ showOperationChooser?: boolean; /** * Specifies whether the filter row is visible. */ visible?: boolean; } /** * Contains descriptions for filter operations in the filter list. * @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 dxGanttFilterRowOperationDescriptions { /** * Text for the 'Between' operation. */ between?: string; /** * Text for the 'Contains' operation. */ contains?: string; /** * Text for the 'Ends with' operation. */ endsWith?: string; /** * Text for the 'Equals' operation. */ equal?: string; /** * Text for the 'Greater than' operation. */ greaterThan?: string; /** * Text for the 'Greater than or equal to' operation. */ greaterThanOrEqual?: string; /** * Text for the 'Less than' operation. */ lessThan?: string; /** * Text for the 'Less than or equal to' operation. */ lessThanOrEqual?: string; /** * Text for the 'Does not contain' operation. */ notContains?: string; /** * Text for the 'Does not equal' operation. */ notEqual?: string; /** * Text for the 'Starts with' operation. */ startsWith?: string; } /** * Configures the header filter. * @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 dxGanttHeaderFilter { /** * Specifies whether to enable searching in the header filter. * @deprecated Use search.enabled instead. */ allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies the height of the popup window that contains values for filtering. */ height?: number; /** * Configures the header filter's search functionality. */ search?: DevExpress.common.grids.HeaderFilterSearchConfig; /** * Specifies a delay in milliseconds between typing a search string and the search execution. * @deprecated Use search.timeout instead. */ searchTimeout?: number; /** * Contains properties that specify text for various elements of the popup window. */ texts?: dxGanttHeaderFilterTexts; /** * Specifies whether to show header filter icons. */ visible?: boolean; /** * Specifies the width of the popup window that contains values for filtering. */ width?: number; } /** * * @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 dxGanttHeaderFilterTexts { /** * Specifies text for the 'Cancel' button in the popup window. */ cancel?: string; /** * Specifies text for the '(Blank)' item in the popup window. */ emptyValue?: string; /** * Specifies text for the 'OK' button in the popup window. */ ok?: string; } /** * * @deprecated * @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 dxGanttOptions extends WidgetOptions { /** * Specifies whether users can select tasks in the Gantt. */ allowSelection?: boolean; /** * An array of columns in the Gantt. */ columns?: Array | undefined; /** * Configures dependencies. */ dependencies?: { /** * Binds the UI component to the data source which contains dependencies. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field that provides keys for dependencies. */ keyExpr?: string | Function; /** * Specifies the data field that provides predecessor IDs. */ predecessorIdExpr?: string | Function; /** * Specifies the data field that provides successor IDs. */ successorIdExpr?: string | Function; /** * Specifies the data field that provides dependency types. */ typeExpr?: string | Function; }; /** * Configures edit properties. */ editing?: { /** * Specifies whether a user can add dependencies. */ allowDependencyAdding?: boolean; /** * Specifies whether a user can delete dependencies. */ allowDependencyDeleting?: boolean; /** * Specifies whether a user can add resources. tasks. */ allowResourceAdding?: boolean; /** * Specifies whether a user can delete resources. */ allowResourceDeleting?: boolean; /** * For internal use only. */ allowResourceUpdating?: boolean; /** * Specifies whether a user can add tasks. */ allowTaskAdding?: boolean; /** * Specifies whether a user can delete tasks. */ allowTaskDeleting?: boolean; /** * Specifies whether users can update a task's resources. */ allowTaskResourceUpdating?: boolean; /** * Specifies whether a user can update tasks. */ allowTaskUpdating?: boolean; /** * Specifies whether a user can edit tasks, resources and dependencies. */ enabled?: boolean; }; /** * Configures validation properties. */ validation?: { /** * Enables task dependencies validation. */ validateDependencies?: boolean; /** * Specifies whether to recalculate the parent task's duration and progress when its child tasks are modified. */ autoUpdateParentTasks?: boolean; /** * Specifies whether users can move or resize a predecessor to change a gap before a successor according to the dependency rules. */ enablePredecessorGap?: boolean; }; /** * Configures sort settings. */ sorting?: dxGanttSorting; /** * Configures filter row settings. */ filterRow?: dxGanttFilterRow; /** * Configures the header filter settings. */ headerFilter?: dxGanttHeaderFilter; /** * A function that is executed after users select a task or clear its selection. */ onSelectionChanged?: ( e: DevExpress.ui.dxGantt.SelectionChangedEvent ) => void; /** * A function that is executed after a custom command item was clicked. Allows you to implement a custom command's functionality. */ onCustomCommand?: (e: DevExpress.ui.dxGantt.CustomCommandEvent) => void; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxGantt.ContextMenuPreparingEvent ) => void; /** * A function that is executed before a task is inserted. */ onTaskInserting?: (e: DevExpress.ui.dxGantt.TaskInsertingEvent) => void; /** * A function that is executed when a task is inserted. */ onTaskInserted?: (e: DevExpress.ui.dxGantt.TaskInsertedEvent) => void; /** * A function that is executed before a task is deleted. */ onTaskDeleting?: (e: DevExpress.ui.dxGantt.TaskDeletingEvent) => void; /** * A function that is executed when a task is deleted. */ onTaskDeleted?: (e: DevExpress.ui.dxGantt.TaskDeletedEvent) => void; /** * A function that is executed before a task is updated. */ onTaskUpdating?: (e: DevExpress.ui.dxGantt.TaskUpdatingEvent) => void; /** * A function that is executed when a task is updated. */ onTaskUpdated?: (e: DevExpress.ui.dxGantt.TaskUpdatedEvent) => void; /** * A function that is executed before a task is moved. */ onTaskMoving?: (e: DevExpress.ui.dxGantt.TaskMovingEvent) => void; /** * A function that is executed before the edit dialog is shown. */ onTaskEditDialogShowing?: ( e: DevExpress.ui.dxGantt.TaskEditDialogShowingEvent ) => void; /** * A function that is executed before the Resource Manager dialog is shown. */ onResourceManagerDialogShowing?: ( e: DevExpress.ui.dxGantt.ResourceManagerDialogShowingEvent ) => void; /** * A function that is executed before a dependency is inserted. */ onDependencyInserting?: ( e: DevExpress.ui.dxGantt.DependencyInsertingEvent ) => void; /** * A function that is executed when a dependency is inserted. */ onDependencyInserted?: ( e: DevExpress.ui.dxGantt.DependencyInsertedEvent ) => void; /** * A function that is executed before a dependency is deleted. */ onDependencyDeleting?: ( e: DevExpress.ui.dxGantt.DependencyDeletingEvent ) => void; /** * A function that is executed when a dependency is deleted. */ onDependencyDeleted?: ( e: DevExpress.ui.dxGantt.DependencyDeletedEvent ) => void; /** * A function that is executed before a resource is inserted. */ onResourceInserting?: ( e: DevExpress.ui.dxGantt.ResourceInsertingEvent ) => void; /** * A function that is executed when a resource is inserted. */ onResourceInserted?: ( e: DevExpress.ui.dxGantt.ResourceInsertedEvent ) => void; /** * A function that is executed before a resource is deleted. */ onResourceDeleting?: ( e: DevExpress.ui.dxGantt.ResourceDeletingEvent ) => void; /** * A function that is executed when a resource is deleted. */ onResourceDeleted?: (e: DevExpress.ui.dxGantt.ResourceDeletedEvent) => void; /** * A function that is executed before a resource is assigned to a task. */ onResourceAssigning?: ( e: DevExpress.ui.dxGantt.ResourceAssigningEvent ) => void; /** * A function that is executed when a resource is assigned to a task. */ onResourceAssigned?: ( e: DevExpress.ui.dxGantt.ResourceAssignedEvent ) => void; /** * A function that is executed before a resource is unassigned from a task. */ onResourceUnassigning?: ( e: DevExpress.ui.dxGantt.ResourceUnassigningEvent ) => void; /** * A function that is executed when a resource is unassigned from a task. */ onResourceUnassigned?: ( e: DevExpress.ui.dxGantt.ResourceUnassignedEvent ) => void; /** * A function that is executed when a user clicks a task. */ onTaskClick?: (e: DevExpress.ui.dxGantt.TaskClickEvent) => void; /** * A function that is executed when a user double-clicks a task. */ onTaskDblClick?: (e: DevExpress.ui.dxGantt.TaskDblClickEvent) => void; /** * A function that is executed before a scale cell is prepared. */ onScaleCellPrepared?: ( e: DevExpress.ui.dxGantt.ScaleCellPreparedEvent ) => void; /** * Configures resource assignments. */ resourceAssignments?: { /** * Binds the UI component to the data source, which contains resource assignments. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field that provides keys for resource assignments. */ keyExpr?: string | Function; /** * Specifies the data field that provides resource IDs. */ resourceIdExpr?: string | Function; /** * Specifies the data field that provides task IDs. */ taskIdExpr?: string | Function; }; /** * Configures task resources. */ resources?: { /** * Specifies the data field that provides resources' color. */ colorExpr?: string | Function; /** * Binds the UI component to the data source, which contains resources. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field that provides keys for resources. */ keyExpr?: string | Function; /** * Specifies the data field that provides resource texts. */ textExpr?: string | Function; }; /** * Specifies the zoom level of tasks in the Gantt chart. */ scaleType?: DevExpress.ui.dxGantt.GanttScaleType; /** * Configures zoom range settings. */ scaleTypeRange?: { /** * Specifies the minimum zoom level of tasks in the Gantt chart. */ min?: DevExpress.ui.dxGantt.GanttScaleType; /** * Specifies the maximum zoom level of tasks in the Gantt chart. */ max?: DevExpress.ui.dxGantt.GanttScaleType; }; /** * Allows you to select a row or determine which row is selected. */ selectedRowKey?: any | undefined; /** * Specifies whether to display task resources. */ showResources?: boolean; /** * Specifies whether to display dependencies between tasks. */ showDependencies?: boolean; /** * Specifies whether to show/hide horizontal faint lines that separate tasks. */ showRowLines?: boolean; /** * Specifies the width of task list columns in pixels. */ taskListWidth?: number; /** * Specifies a task's title position. */ taskTitlePosition?: DevExpress.ui.dxGantt.GanttTaskTitlePosition; /** * Specifies the first day of a week. */ firstDayOfWeek?: DevExpress.common.FirstDayOfWeek | undefined; /** * Configures tasks. */ tasks?: { /** * Specifies the data field that provides tasks' color. */ colorExpr?: string | Function; /** * Binds the UI component to the data source which contains tasks. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field that provides tasks' end dates. */ endExpr?: string | Function; /** * Specifies the data field that provides keys for tasks. */ keyExpr?: string | Function; /** * Specifies the data field that provides tasks' parent IDs. */ parentIdExpr?: string | Function; /** * Specifies the data field that provides tasks' progress. */ progressExpr?: string | Function; /** * Specifies the data field that provides tasks' start dates. */ startExpr?: string | Function; /** * Specifies the data field that provides task titles. */ titleExpr?: string | Function; }; /** * Configures toolbar settings. */ toolbar?: dxGanttToolbar; /** * Configures the context menu settings. */ contextMenu?: dxGanttContextMenu; /** * Configures strip lines. */ stripLines?: Array; /** * Specifies custom content for the task tooltip. */ taskTooltipContentTemplate?: | template | (( container: DevExpress.core.DxElement, task: any ) => string | DevExpress.core.UserDefinedElement); /** * Specifies custom content for the tooltip that displays the task's start and end time while the task is resized in the UI. */ taskTimeTooltipContentTemplate?: | template | (( container: DevExpress.core.DxElement, item: DevExpress.ui.dxGantt.TimeTooltipTemplateData ) => string | DevExpress.core.UserDefinedElement); /** * Specifies custom content for the tooltip that displays the task's progress while the progress handler is resized in the UI. */ taskProgressTooltipContentTemplate?: | template | (( container: DevExpress.core.DxElement, item: DevExpress.ui.dxGantt.ProgressTooltipTemplateData ) => string | DevExpress.core.UserDefinedElement); /** * Specifies custom content for the task. */ taskContentTemplate?: | template | (( container: DevExpress.core.DxElement, item: DevExpress.ui.dxGantt.TaskContentTemplateData ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the root task's identifier. */ rootValue?: any; /** * Specifies the start date of the date interval in the Gantt chart. */ startDateRange?: Date; /** * Specifies the end date of the date interval in the Gantt chart. */ endDateRange?: Date; } /** * Configures sorting. * @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 dxGanttSorting { /** * Specifies text for the context menu item that sets an ascending sort order in a column. */ ascendingText?: string; /** * Specifies text for the context menu item that clears sorting settings for a column. */ clearText?: string; /** * Specifies text for the context menu item that sets a descending sort order in a column. */ descendingText?: string; /** * Specifies sort mode. */ mode?: DevExpress.common.SingleMultipleOrNone | string; /** * Specifies whether to display sort indexes in column headers. Applies only when sorting.mode is 'multiple' and data is sorted by two or more columns. */ showSortIndexes?: boolean; } /** * Configures a strip line. * @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 dxGanttStripLine { /** * Specifies the name of the cascading style sheet (CSS) class associated with the strip line. */ cssClass?: string | undefined; /** * Specifies the end point of the strip line. */ end?: Date | number | string | (() => Date | number | string) | undefined; /** * Specifies the start point of the strip line. */ start?: Date | number | string | (() => Date | number | string) | undefined; /** * Specifies the strip line's title. */ title?: string | undefined; } /** * Configures the toolbar. * @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 dxGanttToolbar { /** * Configures toolbar items' settings. */ items?: Array< | DevExpress.ui.dxGantt.ToolbarItem | DevExpress.ui.dxGantt.GanttPredefinedToolbarItem >; } /** * @deprecated Use ToolbarItem instead * @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 dxGanttToolbarItem extends DevExpress.ui.dxToolbar.Item { /** * Specifies the toolbar item's name. */ name?: DevExpress.ui.dxGantt.GanttPredefinedToolbarItem | string; /** * Specifies the toolbar item's location. */ location?: DevExpress.common.ToolbarItemLocation; } /** * HTML Editor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML. HTML Editor is built on top of and requires the DevExtreme Quill. */ export class dxHtmlEditor extends Editor { /** * Removes focus from the content field of the editor. */ blur(): void; /** * Clears the history of changes. */ clearHistory(): void; /** * Deletes content from the given range. */ delete(index: number, length: number): void; /** * Applies a format to the selected content. Cannot be used with embedded formats. */ format( formatName: DevExpress.ui.dxHtmlEditor.HtmlEditorFormat | string, formatValue: any ): void; /** * Applies a single block format to all lines in the given range. */ formatLine( index: number, length: number, formatName: DevExpress.ui.dxHtmlEditor.HtmlEditorFormat | string, formatValue: any ): void; /** * Applies several block formats to all lines in the given range. */ formatLine(index: number, length: number, formats: any): void; /** * Applies a single text format to all characters in the given range. */ formatText( index: number, length: number, formatName: DevExpress.ui.dxHtmlEditor.HtmlEditorFormat | string, formatValue: any ): void; /** * Applies several text formats to all characters in the given range. */ formatText(index: number, length: number, formats: any): void; /** * Gets a format, module, or Parchment. */ get(componentPath: string): any; /** * Retrieves the pixel position and size of a selection at a specified location. */ getBounds(index: number, length: number): any; /** * Retrieves formatting of the text within the current selection range. */ getFormat(): any; /** * Gets formats applied to the content in the specified range. */ getFormat(index: number, length: number): any; /** * Gets the entire content's length. */ getLength(): number; /** * Gets the instance of a module. */ getModule(moduleName: string): any; /** * Gets the DevExtreme Quill's instance. */ getQuillInstance(): any; /** * Gets the selected content's position and length. */ getSelection(focus?: boolean | undefined): any; /** * Retrieves text content from the HTML Editor. */ getText(index: number, length: number): string; /** * Inserts an embedded content at the specified position. */ insertEmbed(index: number, type: string, config: any): void; /** * Inserts text into the HTML Editor. */ insertText( index: number, text: string, formatName: DevExpress.ui.dxHtmlEditor.HtmlEditorFormat | string, formatValue: any ): void; /** * Inserts formatted text at the specified position. Used with all formats except embedded. */ insertText(index: number, text: string, formats: any): void; /** * Reapplies the most recent undone change. Repeated calls reapply preceding undone changes. */ redo(): void; /** * Registers custom formats and modules. */ register(modules: any): void; /** * Removes all formatting and embedded content from the specified range. */ removeFormat(index: number, length: number): void; /** * Selects and highlights content in the specified range. */ setSelection(index: number, length: number): void; /** * Reverses the most recent change. Repeated calls reverse preceding changes. */ undo(): void; } module dxHtmlEditor { export type AIChangeStyleOption = | 'formal' | 'informal' | 'technical' | 'business' | 'creative' | 'journalistic' | 'academic' | 'persuasive' | 'narrative' | 'expository' | 'descriptive' | 'conversational'; export type AIChangeToneOption = | 'professional' | 'casual' | 'straightforward' | 'confident' | 'friendly'; export type AICommandName = | 'summarize' | 'proofread' | 'expand' | 'shorten' | 'changeStyle' | 'changeTone' | 'translate' | 'askAI'; /** * An extended type for command names. Includes predefined and custom command names. */ export type AICommandNameExtended = AICommandName | 'custom'; export type AITranslateOption = | 'arabic' | 'chinese' | 'english' | 'french' | 'german' | 'japanese' | 'spanish'; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxHtmlEditor, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxHtmlEditor, FocusEvent >; export type HtmlEditorFormat = | 'background' | 'bold' | 'color' | 'font' | 'italic' | 'link' | 'size' | 'strike' | 'script' | 'underline' | 'blockquote' | 'header' | 'indent' | 'list' | 'align' | 'code-block'; export type HtmlEditorImageUploadMode = 'base64' | 'server' | 'both'; export type HtmlEditorImageUploadTab = 'url' | 'file'; export type HtmlEditorPredefinedContextMenuItem = | 'background' | 'bold' | 'color' | 'font' | 'italic' | 'link' | 'image' | 'strike' | 'subscript' | 'superscript' | 'underline' | 'blockquote' | 'increaseIndent' | 'decreaseIndent' | 'orderedList' | 'bulletList' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'codeBlock' | 'variable' | 'undo' | 'redo' | 'clear' | 'insertTable' | 'insertHeaderRow' | 'insertRowAbove' | 'insertRowBelow' | 'insertColumnLeft' | 'insertColumnRight' | 'deleteColumn' | 'deleteRow' | 'deleteTable' | 'cellProperties' | 'tableProperties'; export type HtmlEditorPredefinedToolbarItem = | 'background' | 'bold' | 'color' | 'font' | 'italic' | 'link' | 'image' | 'size' | 'strike' | 'subscript' | 'superscript' | 'underline' | 'blockquote' | 'header' | 'increaseIndent' | 'decreaseIndent' | 'orderedList' | 'bulletList' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'codeBlock' | 'variable' | 'separator' | 'undo' | 'redo' | 'clear' | 'cellProperties' | 'tableProperties' | 'insertTable' | 'insertHeaderRow' | 'insertRowAbove' | 'insertRowBelow' | 'insertColumnLeft' | 'insertColumnRight' | 'deleteColumn' | 'deleteRow' | 'deleteTable' | 'ai'; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; export interface MentionTemplateData { readonly marker: string; readonly id?: string | number; readonly value?: any; } /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxHtmlEditorOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxHtmlEditor, KeyboardEvent | ClipboardEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @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 dxHtmlEditorImageUpload { /** * Specifies a target Url for the upload request. */ uploadUrl?: string | undefined; /** * Specifies a target directory for uploaded images. */ uploadDirectory?: string | undefined; /** * Specifies how the HTML Editor UI component uploads files. */ fileUploadMode?: DevExpress.ui.dxHtmlEditor.HtmlEditorImageUploadMode; /** * Contains an array of tabs in the 'Add an Image' dialog. */ tabs?: Array< | DevExpress.ui.dxHtmlEditor.ImageUploadTab | DevExpress.ui.dxHtmlEditor.HtmlEditorImageUploadTab >; /** * Configures the file uploader options. */ fileUploaderOptions?: DevExpress.ui.dxFileUploader.Properties; } /** * @deprecated Use ImageUploadTab instead * @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 dxHtmlEditorImageUploadTabItem { /** * Specifies the tab's name. */ name?: DevExpress.ui.dxHtmlEditor.HtmlEditorImageUploadTab | undefined; } /** * * @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 dxHtmlEditorMediaResizing { /** * Specifies media types that can be resized. Currently, only images are supported. */ allowedTargets?: Array; /** * Enables media resizing. */ enabled?: 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 interface dxHtmlEditorMention { /** * Provides data for the suggestion list. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field whose values should be displayed in the suggestion list. */ displayExpr?: string | ((item: any) => string); /** * Specifies a custom template for suggestion list items. */ itemTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the prefix that a user enters to activate mentions. You can use different prefixes with different dataSources. */ marker?: string; /** * Specifies the minimum number of characters that a user should type to trigger the search. */ minSearchLength?: number; /** * Specifies one or several data fields to search. */ searchExpr?: string | Function | Array; /** * Specifies the delay between when a user stops typing and when the search is executed. */ searchTimeout?: number; /** * Specifies a custom template for mentions. */ template?: | template | (( mentionData: DevExpress.ui.dxHtmlEditor.MentionTemplateData, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies which data field provides unique values to the template's `id` parameter. */ valueExpr?: string | Function; } /** * * @deprecated * @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 dxHtmlEditorOptions extends EditorOptions { /** * Binds the AI service to the HTML Editor. */ aiIntegration?: DevExpress.aiIntegration.AIIntegration | undefined; /** * Allows users to break content into multiple lines within a single block element. The Shift + Enter key combination generates the new line. */ allowSoftLineBreak?: boolean; /** * Allows you to customize the DevExtreme Quill and 3rd-party modules. */ customizeModules?: (config: any) => void; /** * Allows you to convert an HTML Editor value between different markups. */ converter?: DevExpress.ui.dxHtmlEditor.Converter | undefined; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Configures media resizing. */ mediaResizing?: dxHtmlEditorMediaResizing; /** * Configures table resize. */ tableResizing?: dxHtmlEditorTableResizing; /** * Configures mentions. */ mentions?: Array; /** * Configures table context menu settings. */ tableContextMenu?: dxHtmlEditorTableContextMenu; /** * Configures the image upload. */ imageUpload?: dxHtmlEditorImageUpload; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * A function that is executed when the UI component gets focus. */ onFocusIn?: (e: DevExpress.ui.dxHtmlEditor.FocusInEvent) => void; /** * A function that is executed when the UI component loses focus. */ onFocusOut?: (e: DevExpress.ui.dxHtmlEditor.FocusOutEvent) => void; /** * Specifies the text displayed when the input field is empty. */ placeholder?: string; /** * Configures the UI component's toolbar. */ toolbar?: dxHtmlEditorToolbar; /** * Configures variables that are placeholders for values created once text is processed. */ variables?: dxHtmlEditorVariables; /** * Specifies how the HTML Editor's toolbar and content field are styled. */ stylingMode?: DevExpress.common.EditorStyle; } /** * Configures table context menu settings. * @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 dxHtmlEditorTableContextMenu { /** * Specifies whether to enable the table context menu. */ enabled?: boolean; /** * Configures context menu items. */ items?: Array< | DevExpress.ui.dxHtmlEditor.ContextMenuItem | DevExpress.ui.dxHtmlEditor.HtmlEditorPredefinedContextMenuItem >; } /** * @deprecated Use DevExpress.ui.dxHtmlEditor.ContextMenuItem instead * @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 dxHtmlEditorTableContextMenuItem extends DevExpress.ui.dxMenu.MenuBasePlainItem { /** * A name used to identify the context menu item. */ name?: | DevExpress.ui.dxHtmlEditor.HtmlEditorPredefinedContextMenuItem | undefined; /** * Configures nested context menu items. */ items?: Array< | DevExpress.ui.dxHtmlEditor.ContextMenuItem | DevExpress.ui.dxHtmlEditor.HtmlEditorPredefinedContextMenuItem >; } /** * * @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 dxHtmlEditorTableResizing { /** * The minimum column width. */ minColumnWidth?: number; /** * The minimum row height. */ minRowHeight?: number; /** * Enables users to resize tables. */ enabled?: 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 interface dxHtmlEditorToolbar { /** * Specifies the container in which to place the toolbar. */ container?: string | DevExpress.core.UserDefinedElement; /** * Configures toolbar items. These items allow users to format text and execute commands. */ items?: Array< | DevExpress.ui.dxHtmlEditor.ToolbarItem | DevExpress.ui.dxHtmlEditor.HtmlEditorPredefinedToolbarItem >; /** * Specifies whether or not items are arranged into multiple lines when their combined width exceeds the toolbar width. */ multiline?: boolean; } /** * @deprecated Use ToolbarItem instead * @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 dxHtmlEditorToolbarItem extends DevExpress.ui.dxToolbar.Item { /** * Specifies the predefined item that this object customizes or a format with multiple choices. */ name?: DevExpress.ui.dxHtmlEditor.HtmlEditorPredefinedToolbarItem | string; /** * Specifies values for a format with multiple choices. Should be used with the name. */ acceptedValues?: Array; /** * Specifies a location for the item on the toolbar. */ location?: DevExpress.common.ToolbarItemLocation; } /** * * @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 dxHtmlEditorVariables { /** * Specifies a collection of variables available for a user. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the special character(s) that should surround the variables. */ escapeChar?: string | Array; } /** * Specifies markup for a UI component item. */ export var dxItem: any; /** * The List is a UI component that represents a collection of items in a scrollable list. */ export class dxList< TItem extends DevExpress.ui.dxList.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> { /** * Gets the UI component's height in pixels. */ clientHeight(): number; /** * Collapses a group with a specific index. */ collapseGroup(groupIndex: number): DevExpress.core.utils.DxPromise; /** * Removes an item found using its DOM node. */ deleteItem(itemElement: Element): DevExpress.core.utils.DxPromise; /** * Removes an item with a specific index. */ deleteItem(itemIndex: number | any): DevExpress.core.utils.DxPromise; /** * Expands a group with a specific index. */ expandGroup(groupIndex: number): DevExpress.core.utils.DxPromise; /** * Checks whether an item found using its DOM node is selected. */ isItemSelected(itemElement: Element): boolean; /** * Checks whether an item with a specific index is selected. */ isItemSelected(itemIndex: number | any): boolean; /** * Reloads list data. */ reload(): void; /** * Reorders items found using their DOM nodes. */ reorderItem( itemElement: Element, toItemElement: Element ): DevExpress.core.utils.DxPromise; /** * Reorders items with specific indexes. */ reorderItem( itemIndex: number | any, toItemIndex: number | any ): DevExpress.core.utils.DxPromise; /** * Scrolls the content by a specified distance. */ scrollBy(distance: number): void; /** * Gets the content's height in pixels. */ scrollHeight(): number; /** * Scrolls the content to a specific position. */ scrollTo(location: number): void; /** * Scrolls the content to an item found using its DOM node. */ scrollToItem(itemElement: Element): void; /** * Scrolls the content to an item with a specific index. */ scrollToItem(itemIndex: number | any): void; /** * Gets the top scroll offset. */ scrollTop(): number; /** * Selects all items. */ selectAll(): void; /** * Selects an item found using its DOM node. */ selectItem(itemElement: Element): void; /** * Selects an item with a specific index. */ selectItem(itemIndex: number | any): void; /** * Cancels the selection of all items. */ unselectAll(): void; /** * Cancels the selection of an item found using its DOM node. */ unselectItem(itemElement: Element): void; /** * Cancels the selection of an item with a specific index. */ unselectItem(itemIndex: number | any): void; /** * Updates the UI component scrollbar according to UI component content size. */ updateDimensions(): DevExpress.core.utils.DxPromise; } module dxList { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; GroupRenderedEvent: GroupRenderedEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemDeletedEvent: ItemDeletedEvent; ItemDeletingEvent: ItemDeletingEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; ItemReorderedEvent: ItemReorderedEvent; ItemSwipeEvent: ItemSwipeEvent; OptionChangedEvent: OptionChangedEvent; PageLoadingEvent: PageLoadingEvent; PullRefreshEvent: PullRefreshEvent; ScrollEvent: ScrollEvent; SelectAllValueChangedEvent: SelectAllValueChangedEvent; SelectionChangingEvent: SelectionChangingEvent; SelectionChangedEvent: SelectionChangedEvent; }; /** * The type of the groupRendered event handler's argument. */ export type GroupRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly groupData?: any; /** * */ readonly groupElement?: DevExpress.core.DxElement; /** * */ readonly groupIndex?: number; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxList, KeyboardEvent | MouseEvent | PointerEvent > & ListItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxList, DevExpress.events.PointerInteractionEvent > & ListItemInfo; /** * The type of the itemDeleted event handler's argument. */ export type ItemDeletedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & ListItemInfo; export type ItemDeleteMode = | 'context' | 'slideButton' | 'slideItem' | 'static' | 'swipe' | 'toggle'; /** * The type of the itemDeleting event handler's argument. */ export type ItemDeletingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & ListItemInfo & { /** * */ cancel?: boolean | PromiseLike | PromiseLike; }; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxList, DevExpress.events.PointerInteractionEvent > & ListItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends Item | any = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the itemReordered event handler's argument. */ export type ItemReorderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & ListItemInfo & { /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; }; /** * The type of the itemSwipe event handler's argument. */ export type ItemSwipeEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxList, DevExpress.events.PointerInteractionEvent > & ListItemInfo & { /** * */ readonly direction: 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 interface ListItemInfo { /** * */ readonly itemData?: TItem; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly itemIndex: number | { group: number; item: number }; } export type ListMenuMode = 'context' | 'slide'; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the pageLoading event handler's argument. */ export type PageLoadingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type Properties< TItem extends ItemLike = any, TKey = any > = dxListOptions; /** * The type of the pullRefresh event handler's argument. */ export type PullRefreshEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the scroll event handler's argument. */ export type ScrollEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxList, Event > & ScrollInfo; /** * * @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 ScrollInfo { /** * */ readonly scrollOffset?: any; /** * */ readonly reachedLeft: boolean; /** * */ readonly reachedRight: boolean; /** * */ readonly reachedTop: boolean; /** * */ readonly reachedBottom: boolean; } /** * The type of the selectAllValueChanged event handler's argument. */ export type SelectAllValueChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly value: boolean; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; /** * The type of the selectionChanging event handler's argument. */ export type SelectionChangingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.ui.CollectionWidget.SelectionChangingEventBase< dxList >; } /** * @deprecated Use Item instead * @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 dxListItem extends CollectionWidgetItem { /** * Specifies the text of a badge displayed for the list item. */ badge?: string; /** * Specifies the list item's icon. */ icon?: string; /** * Specifies the name of the list items group in a grouped list. */ key?: string; /** * Specifies whether or not to display a chevron for the list item. */ showChevron?: boolean; } /** * * @deprecated */ export interface dxListOptions< TItem extends DevExpress.ui.dxList.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey>, SearchBoxMixinOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether or not an end user can delete list items. */ allowItemDeleting?: boolean; /** * A Boolean value specifying whether to enable or disable the bounce-back effect. */ bounceEnabled?: boolean; /** * Specifies whether or not an end user can collapse groups. */ collapsibleGroups?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data field whose values should be displayed. Defaults to 'text' when the data source contains objects. */ displayExpr?: string | ((item: TItem) => string) | undefined; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies a custom template for group captions. */ groupTemplate?: | template | (( groupData: any, groupIndex: number, groupElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether data items should be grouped. */ grouped?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data. */ indicateLoading?: boolean; /** * Specifies the way a user can delete items from the list. */ itemDeleteMode?: DevExpress.ui.dxList.ItemDeleteMode; /** * Configures item reordering using drag and drop gestures. */ itemDragging?: dxSortableOptions; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies the array of items for a context menu called for a list item. */ menuItems?: Array<{ /** * Holds on a function called when the item is clicked. */ action?: (itemElement: DevExpress.core.DxElement, itemData: TItem) => any; /** * Specifies the menu item text. */ text?: string; }>; /** * Specifies whether an item context menu is shown when a user holds or swipes an item. */ menuMode?: DevExpress.ui.dxList.ListMenuMode; /** * The text displayed on the button used to load the next page from the data source. */ nextButtonText?: string; /** * A function that is executed when a group element is rendered. */ onGroupRendered?: ( e: DevExpress.ui.dxList.GroupRenderedEvent ) => void; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick?: | ((e: DevExpress.ui.dxList.ItemClickEvent) => void) | string; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu?: ( e: DevExpress.ui.dxList.ItemContextMenuEvent ) => void; /** * A function that is executed after a list item is deleted from the data source. */ onItemDeleted?: ( e: DevExpress.ui.dxList.ItemDeletedEvent ) => void; /** * A function that is executed before a collection item is deleted from the data source. */ onItemDeleting?: ( e: DevExpress.ui.dxList.ItemDeletingEvent ) => void; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold?: (e: DevExpress.ui.dxList.ItemHoldEvent) => void; /** * A function that is executed after a list item is moved to another position. */ onItemReordered?: ( e: DevExpress.ui.dxList.ItemReorderedEvent ) => void; /** * A function that is executed when a list item is swiped. */ onItemSwipe?: (e: DevExpress.ui.dxList.ItemSwipeEvent) => void; /** * A function that is executed before the next page is loaded. */ onPageLoading?: ( e: DevExpress.ui.dxList.PageLoadingEvent ) => void; /** * A function that is executed when the 'pull to refresh' gesture is performed. Supported on mobile devices only. */ onPullRefresh?: ( e: DevExpress.ui.dxList.PullRefreshEvent ) => void; /** * A function that is executed on each scroll gesture. */ onScroll?: (e: DevExpress.ui.dxList.ScrollEvent) => void; /** * A function that is executed when the 'Select All' check box value is changed. Applies only if the selectionMode is 'all'. */ onSelectAllValueChanged?: ( e: DevExpress.ui.dxList.SelectAllValueChangedEvent ) => void; /** * Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the 'next' button is clicked. */ pageLoadMode?: DevExpress.common.PageLoadMode; /** * Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ pageLoadingText?: string; /** * A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. */ pullRefreshEnabled?: boolean; /** * Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ pulledDownText?: string; /** * Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ pullingDownText?: string; /** * Specifies the text displayed in the pullDown panel while the list is being refreshed. */ refreshingText?: string; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly?: boolean; /** * A Boolean value specifying if the list is scrolled by content. */ scrollByContent?: boolean; /** * Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false. */ scrollByThumb?: boolean; /** * A Boolean value specifying whether to enable or disable list scrolling. */ scrollingEnabled?: boolean; /** * Specifies the mode in which all items are selected. */ selectAllMode?: DevExpress.common.SelectAllMode; /** * Specifies whether an item is selected if a user clicks it. */ selectByClick?: boolean; /** * Specifies item selection mode. */ selectionMode?: DevExpress.common.SingleMultipleAllOrNone; /** * Specifies when the UI component shows the scrollbar. */ showScrollbar?: DevExpress.common.ScrollbarMode; /** * Specifies whether or not to display controls used to select list items. Not available if selectionMode is set to 'none'. */ showSelectionControls?: boolean; /** * Specifies the text displayed at the 'Select All' check box. */ selectAllText?: string; /** * Specifies whether or not the UI component uses native scrolling. */ useNativeScrolling?: boolean; } /** * The LoadIndicator is a UI element notifying the viewer that a process is in progress. */ export class dxLoadIndicator extends Widget {} module dxLoadIndicator { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxLoadIndicatorOptions; } /** * * @deprecated * @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 dxLoadIndicatorOptions extends WidgetOptions { /** * Specifies the path to an image used as the indicator. */ indicatorSrc?: string; } /** * The LoadPanel is an overlay UI component notifying the viewer that loading is in progress. */ export class dxLoadPanel extends dxOverlay {} module dxLoadPanel { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hidden event handler's argument. */ export type HiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hiding event handler's argument. */ export type HidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxLoadPanelOptions; /** * The type of the showing event handler's argument. */ export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo; } /** * Configures UI component visibility animations. This object contains two fields: show and hide. * @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 dxLoadPanelAnimation extends dxOverlayAnimation { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; } /** * * @deprecated * @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 dxLoadPanelOptions extends dxOverlayOptions { /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: dxLoadPanelAnimation; /** * Specifies the UI component's container. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * The delay in milliseconds after which the load panel is displayed. */ delay?: number; /** * Specifies whether or not the UI component can be focused. */ focusStateEnabled?: boolean; /** * Specifies the UI component's height. */ height?: number | string; /** * A URL pointing to an image to be used as a load indicator. */ indicatorSrc?: string; /** * Specifies the maximum height the UI component can reach while resizing. */ maxHeight?: number | string; /** * Specifies the maximum width the UI component can reach while resizing. */ maxWidth?: number | string; /** * Specifies the text displayed in the load panel. Ignored in the Material Design theme. */ message?: string; /** * Positions the UI component. */ position?: | DevExpress.common.PositionAlignment | DevExpress.common.core.animation.PositionConfig | Function; /** * Specifies the shading color. Applies only if shading is enabled. */ shadingColor?: string; /** * A Boolean value specifying whether or not to show a load indicator. */ showIndicator?: boolean; /** * A Boolean value specifying whether or not to show the pane behind the load indicator. */ showPane?: boolean; /** * Specifies the UI component's width. */ width?: number | string; } /** * The Lookup is a UI component that allows an end user to search for an item in a collection shown in a drop-down menu. */ export class dxLookup extends dxDropDownList {} module dxLookup { /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxLookup, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the pageLoading event handler's argument. */ export type PageLoadingEvent = DevExpress.common.core.events.EventInfo; export type Properties = dxLookupOptions; /** * The type of the pullRefresh event handler's argument. */ export type PullRefreshEvent = DevExpress.common.core.events.EventInfo; /** * The type of the scroll event handler's argument. */ export type ScrollEvent = DevExpress.common.core.events.NativeEventInfo< dxLookup, MouseEvent | Event > & DevExpress.ui.dxList.ScrollInfo; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxDropDownList.SelectionChangedInfo; export type TitleRenderedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxPopup.TitleRenderedInfo; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxLookup, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxLookupOptions extends dxDropDownListOptions { /** * The text displayed on the Apply button. */ applyButtonText?: string; /** * Specifies the way an end user applies the selected value. */ applyValueMode?: DevExpress.common.ApplyValueMode; /** * The text displayed on the Cancel button. */ cancelButtonText?: string; /** * Specifies whether or not the UI component cleans the search box when the popup window is displayed. */ cleanSearchOnOpening?: boolean; /** * The text displayed on the Clear button. */ clearButtonText?: string; /** * Specifies a custom template for the input field. */ fieldTemplate?: | template | (( selectedItem: any, fieldElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies a custom template for group captions. */ groupTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether data items should be grouped. */ grouped?: boolean; /** * The text displayed on the button used to load the next page from the data source. */ nextButtonText?: string; /** * A function that is executed before the next page is loaded. */ onPageLoading?: (e: DevExpress.ui.dxLookup.PageLoadingEvent) => void; /** * A function that is executed when the 'pull to refresh' gesture is performed on the drop-down item list. Supported on mobile devices only. */ onPullRefresh?: (e: DevExpress.ui.dxLookup.PullRefreshEvent) => void; /** * A function that is executed on each scroll gesture performed on the drop-down item list. */ onScroll?: (e: DevExpress.ui.dxLookup.ScrollEvent) => void; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: (e: DevExpress.ui.dxLookup.ValueChangedEvent) => void; /** * Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the 'next' button is clicked. */ pageLoadMode?: DevExpress.common.PageLoadMode; /** * Specifies the text shown in the pullDown panel, which is displayed when the UI component is scrolled to the bottom. */ pageLoadingText?: string; /** * The text displayed by the UI component when nothing is selected. */ placeholder?: string; /** * A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. */ pullRefreshEnabled?: boolean; /** * Specifies the text displayed in the pullDown panel when the UI component is pulled below the refresh threshold. */ pulledDownText?: string; /** * Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ pullingDownText?: string; /** * Specifies the text displayed in the pullDown panel while the UI component is being refreshed. */ refreshingText?: string; /** * Specifies whether the search box is visible. */ searchEnabled?: boolean; /** * The text that is provided as a hint in the lookup's search bar. */ searchPlaceholder?: string; /** * Specifies whether to display the Cancel button in the lookup window. */ showCancelButton?: boolean; /** * Specifies whether to display the Clear button in the lookup window. */ showClearButton?: boolean; /** * Specifies the DOM events after which the UI component's search results should be updated. */ searchStartEvent?: string; /** * Specifies whether or not the UI component uses native scrolling. */ useNativeScrolling?: boolean; /** * Specifies whether to show lookup contents in the Popover UI component. */ usePopover?: boolean; /** * Specifies whether to vertically align the drop-down menu so that the selected item is in its center. Applies only in Material Design themes. */ dropDownCentered?: boolean; /** * Configures the drop-down field. */ dropDownOptions?: DevExpress.ui.dxPopover.Properties; } /** * The Map is an interactive UI component that displays a geographic map with markers and routes. */ export class dxMap extends Widget { /** * Adds a marker to the map. */ addMarker( markerOptions: any | Array ): DevExpress.core.utils.DxPromise; /** * Adds a route to the map. */ addRoute(options: any | Array): DevExpress.core.utils.DxPromise; /** * Removes a marker from the map. */ removeMarker( marker: any | number | Array ): DevExpress.core.utils.DxPromise; /** * Removes a route from the map. */ removeRoute( route: any | number | Array ): DevExpress.core.utils.DxPromise; } module dxMap { /** * The type of the click event handler's argument. */ export type ClickEvent = DevExpress.common.core.events.NativeEventInfo< dxMap, MouseEvent | PointerEvent > & { /** * The clicked location. */ location: MapLocation; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; export type MapProvider = 'azure' | 'bing' | 'google' | 'googleStatic'; export type MapType = 'hybrid' | 'roadmap' | 'satellite'; /** * The type of the markerAdded event handler's argument. */ export type MarkerAddedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly options: any; /** * */ originalMarker: any; }; /** * The type of the markerRemoved event handler's argument. */ export type MarkerRemovedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly options?: any; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxMapOptions; /** * The type of the ready event handler's argument. */ export type ReadyEvent = DevExpress.common.core.events.EventInfo & { /** * */ originalMap: any; }; /** * The type of the routeAdded event handler's argument. */ export type RouteAddedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly options: any; /** * */ originalRoute: any; }; export type RouteMode = 'driving' | 'walking'; /** * The type of the routeRemoved event handler's argument. */ export type RouteRemovedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly options?: any; }; } /** * * @deprecated * @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 dxMapOptions extends WidgetOptions { /** * Keys to authenticate the component within map providers. */ apiKey?: | string | { /** * A key used to authenticate the component within Azure Maps. */ azure?: string; /** * A key used to authenticate the component within Bing Maps. * @deprecated */ bing?: string; /** * A key used to authenticate the component within Google Maps. */ google?: string; /** * A key used to authenticate the component within Google Maps Static. */ googleStatic?: string; }; /** * Specifies whether the UI component automatically adjusts center and zoom property values when adding a new marker or route, or if a new UI component contains markers or routes by default. */ autoAdjust?: boolean; /** * An object, a string, or an array specifying which part of the map is displayed at the UI component's center using coordinates. The UI component can change this value if autoAdjust is enabled. */ center?: any | string | Array; /** * Specifies whether or not map UI component controls are available. */ controls?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies the UI component's height. */ height?: number | string; /** * A URL pointing to the custom icon to be used for map markers. */ markerIconSrc?: string; /** * An array of markers displayed on a map. */ markers?: Array<{ /** * A URL pointing to the custom icon to be used for the marker. */ iconSrc?: string; /** * Specifies the marker location. */ location?: any | string | Array; /** * A callback function performed when the marker is clicked. */ onClick?: Function; /** * A tooltip to be used for the marker. */ tooltip?: | string | { /** * Specifies whether a tooltip is visible by default or not. */ isShown?: boolean; /** * Specifies the text or HTML markup displayed in the tooltip. */ text?: string; }; }>; /** * A function that is executed when any location on the map is clicked or tapped. */ onClick?: ((e: DevExpress.ui.dxMap.ClickEvent) => void) | string; /** * A function that is executed when a marker is created on the map. */ onMarkerAdded?: (e: DevExpress.ui.dxMap.MarkerAddedEvent) => void; /** * A function that is executed when a marker is removed from the map. */ onMarkerRemoved?: (e: DevExpress.ui.dxMap.MarkerRemovedEvent) => void; /** * A function that is executed when the map is ready. */ onReady?: (e: DevExpress.ui.dxMap.ReadyEvent) => void; /** * A function that is executed when a route is created on the map. */ onRouteAdded?: (e: DevExpress.ui.dxMap.RouteAddedEvent) => void; /** * A function that is executed when a route is removed from the map. */ onRouteRemoved?: (e: DevExpress.ui.dxMap.RouteRemovedEvent) => void; /** * The name of the current map data provider. */ provider?: DevExpress.ui.dxMap.MapProvider; /** * A provider configuration object. */ providerConfig?: { /** * Specifies a map ID for the `google` and `googleStatic` providers. */ mapId?: string; /** * Specifies whether to use advanced markers with the `google` and `googleStatic` providers. * @deprecated */ useAdvancedMarkers?: boolean; }; /** * An array of routes shown on the map. */ routes?: Array<{ /** * Specifies the color of the line displaying the route. */ color?: string; /** * Contains an array of objects making up the route. */ locations?: Array; /** * Specifies a transportation mode to be used in the displayed route. */ mode?: DevExpress.ui.dxMap.RouteMode | string; /** * Specifies the opacity of the line displaying the route. */ opacity?: number; /** * Specifies the thickness of the line displaying the route in pixels. */ weight?: number; }>; /** * The type of a map to display. */ type?: DevExpress.ui.dxMap.MapType; /** * Specifies the UI component's width. */ width?: number | string; /** * The map's zoom level. The UI component can change this value if autoAdjust is enabled. */ zoom?: number; } /** * The Menu UI component is a panel with clickable items. A click on an item opens a drop-down menu, which can contain several submenus. */ export class dxMenu extends dxMenuBase< dxMenuOptions, dxMenuItem, TKey > {} module dxMenu { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; SubmenuHiddenEvent: SubmenuHiddenEvent; SubmenuHidingEvent: SubmenuHidingEvent; SubmenuShowingEvent: SubmenuShowingEvent; SubmenuShownEvent: SubmenuShownEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxMenu, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent = DevExpress.common.core.events.NativeEventInfo< dxMenu, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * @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 MenuBasePlainItem extends CollectionWidgetItem { /** * Specifies whether a group separator is displayed over the item. */ beginGroup?: boolean; /** * Specifies if a menu is closed when a user clicks the item. Does not apply to the root items. */ closeMenuOnClick?: boolean; /** * Specifies whether the menu item responds to user interaction. */ disabled?: boolean; /** * Specifies the menu item's icon. */ icon?: string; /** * Specifies whether or not a user can select a menu item. */ selectable?: boolean; /** * Specifies whether or not the item is selected. */ selected?: boolean; /** * Specifies the text inserted into the item element. */ text?: string; /** * Specifies whether or not the menu item is visible. */ visible?: boolean; [key: string]: any; } /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxMenuOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; export type SubmenuDirection = 'auto' | 'leftOrTop' | 'rightOrBottom'; /** * The type of the submenuHidden event handler's argument. */ export type SubmenuHiddenEvent = DevExpress.common.core.events.EventInfo> & { /** * */ readonly itemData?: Item; /** * */ readonly rootItem?: DevExpress.core.DxElement; /** * */ readonly submenuContainer?: DevExpress.core.DxElement; }; /** * The type of the submenuHiding event handler's argument. */ export type SubmenuHidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & { /** * */ readonly itemData?: Item; /** * */ readonly rootItem?: DevExpress.core.DxElement; /** * */ readonly submenuContainer?: DevExpress.core.DxElement; }; /** * The type of the submenuShowing event handler's argument. */ export type SubmenuShowingEvent = DevExpress.common.core.events.EventInfo> & { /** * */ readonly itemData?: Item; /** * */ readonly rootItem?: DevExpress.core.DxElement; /** * */ readonly submenuContainer?: DevExpress.core.DxElement; }; /** * The type of the submenuShown event handler's argument. */ export type SubmenuShownEvent = DevExpress.common.core.events.EventInfo> & { /** * */ readonly itemData?: Item; /** * */ readonly rootItem?: DevExpress.core.DxElement; /** * */ readonly submenuContainer?: DevExpress.core.DxElement; }; } /** * The base class for UI components containing an item collection. * @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 dxMenuBase< TProperties extends dxMenuBaseOptions, TItem extends dxMenuBaseItem = dxMenuBaseItem, TKey = any > extends HierarchicalCollectionWidget { /** * Selects an item found using its DOM node. */ selectItem(itemElement: Element): void; /** * Cancels the selection of an item found using its DOM node. */ unselectItem(itemElement: Element): 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 dxMenuBaseItem extends DevExpress.ui.dxMenu.MenuBasePlainItem { /** * Specifies nested menu items. */ items?: Array; } /** * * @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 dxMenuBaseOptions< TComponent extends dxMenuBase, TItem extends dxMenuBaseItem = dxMenuBaseItem, TKey = any > extends Omit< HierarchicalCollectionWidgetOptions, 'dataSource' > { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; }; /** * Specifies the name of the CSS class to be applied to the root menu level and all submenus. */ cssClass?: string; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Holds an array of menu items. */ items?: Array; /** * Specifies whether an item is selected if a user clicks it. */ selectByClick?: boolean; /** * Specifies the selection mode supported by the menu. */ selectionMode?: DevExpress.common.SingleOrNone; /** * Specifies properties of submenu showing and hiding. */ showSubmenuMode?: | { /** * Specifies the delay of submenu show and hiding. */ delay?: | { /** * The time span after which the submenu is hidden. */ hide?: number; /** * The time span after which the submenu is shown. */ show?: number; } | number; /** * Specifies the mode name. */ name?: DevExpress.common.SubmenuShowMode; } | DevExpress.common.SubmenuShowMode; } /** * @deprecated Use DevExpress.ui.dxMenu.Item instead * @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 dxMenuItem extends dxMenuBaseItem { /** * Specifies nested menu items. */ items?: Array; /** * Specifies a web address to be opened when a user clicks on an item. */ url?: string; /** * Specifies link attributes for the url option. */ linkAttr?: { [key: string]: any }; } /** * * @deprecated */ export interface dxMenuOptions extends dxMenuBaseOptions, dxMenuItem, TKey> { /** * Specifies whether adaptive rendering is enabled. This property is in effect only if the orientation is 'horizontal'. */ adaptivityEnabled?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike< DevExpress.ui.dxMenu.Item, TKey > | null; /** * Specifies whether or not the submenu is hidden when the mouse pointer leaves it. */ hideSubmenuOnMouseLeave?: boolean; /** * Holds an array of menu items. */ items?: Array; /** * A function that is executed after a submenu is hidden. */ onSubmenuHidden?: ( e: DevExpress.ui.dxMenu.SubmenuHiddenEvent ) => void; /** * A function that is executed before a submenu is hidden. */ onSubmenuHiding?: ( e: DevExpress.ui.dxMenu.SubmenuHidingEvent ) => void; /** * A function that is executed before a submenu is displayed. */ onSubmenuShowing?: ( e: DevExpress.ui.dxMenu.SubmenuShowingEvent ) => void; /** * A function that is executed after a submenu is displayed. */ onSubmenuShown?: (e: DevExpress.ui.dxMenu.SubmenuShownEvent) => void; /** * Specifies whether the menu has horizontal or vertical orientation. */ orientation?: DevExpress.common.Orientation; /** * Specifies properties for showing and hiding the first level submenu. */ showFirstSubmenuMode?: | { /** * Specifies the delay in submenu showing and hiding. */ delay?: | { /** * The time span after which the submenu is hidden. */ hide?: number; /** * The time span after which the submenu is shown. */ show?: number; } | number; /** * Specifies the mode name. */ name?: DevExpress.common.SubmenuShowMode; } | DevExpress.common.SubmenuShowMode; /** * Specifies the direction at which the submenus are displayed. */ submenuDirection?: DevExpress.ui.dxMenu.SubmenuDirection; } /** * The MultiView is a UI component that contains several views. An end user navigates through the views by swiping them in the horizontal direction. */ export class dxMultiView< TItem extends DevExpress.ui.dxMultiView.ItemLike = any, TKey = any > extends CollectionWidget< DevExpress.ui.dxMultiView.Properties, TItem, TKey > {} module dxMultiView { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxMultiView >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxMultiView, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxMultiView, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxMultiView, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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 ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxMultiViewOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; } /** * * @deprecated * @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 dxMultiViewBaseOptions< TComponent extends dxMultiView = dxMultiView, TItem extends DevExpress.ui.dxMultiView.ItemLike = any, TKey = any > extends Omit, 'keyExpr'> { /** * Specifies whether or not to animate the displayed item change. */ animationEnabled?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately. */ deferRendering?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * An array of items displayed by the UI component. */ items?: Array; /** * A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. */ loop?: boolean; /** * The index of the currently displayed item. */ selectedIndex?: number; /** * A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ swipeEnabled?: boolean; } /** * @deprecated Use Item instead * @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 dxMultiViewItem extends CollectionWidgetItem {} /** * * @deprecated */ export interface dxMultiViewOptions< TItem extends DevExpress.ui.dxMultiView.ItemLike = any, TKey = any > extends dxMultiViewBaseOptions, TItem, TKey> {} /** * The NumberBox is a UI component that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse. */ export class dxNumberBox extends dxTextEditor { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxNumberBox.Properties['value']): void; } module dxNumberBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, Event >; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, KeyboardEvent >; export type NumberBoxPredefinedButton = 'clear' | 'spins'; export type NumberBoxType = 'number' | 'text' | 'tel'; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, ClipboardEvent >; export type Properties = dxNumberBoxOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxNumberBox, DevExpress.events.InteractionEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxNumberBoxOptions extends dxTextEditorOptions { /** * Allows you to add custom buttons to the input text field. */ buttons?: Array< | DevExpress.ui.dxNumberBox.NumberBoxPredefinedButton | DevExpress.common.TextEditorButton >; /** * Specifies the value's display format and controls user input accordingly. */ format?: DevExpress.common.core.localization.Format; /** * Specifies the text of the message displayed if the specified value is not a number. */ invalidValueMessage?: string; /** * The maximum value accepted by the number box. */ max?: number | undefined; /** * The minimum value accepted by the number box. */ min?: number | undefined; /** * Specifies the value to be passed to the type attribute of the underlying `` element. */ mode?: DevExpress.ui.dxNumberBox.NumberBoxType; /** * Specifies whether to show the buttons that change the value by a step. */ showSpinButtons?: boolean; /** * Specifies how much the UI component's value changes when using the spin buttons, Up/Down arrow keys, or mouse wheel. */ step?: number; /** * Specifies whether to use touch friendly spin buttons. Applies only if showSpinButtons is true. */ useLargeSpinButtons?: boolean; /** * The current number box value. */ value?: number; } /** * The Overlay UI component represents a window overlaying the current view. It displays data located within the HTML element representing the UI component. * @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 dxOverlay extends Widget { /** * Gets the UI component's content. */ content(): DevExpress.core.DxElement; /** * Hides the UI component. */ hide(): DevExpress.core.utils.DxPromise; /** * Recalculates the UI component's size and position without rerendering. */ repaint(): void; /** * Shows the UI component. */ show(): DevExpress.core.utils.DxPromise; /** * Shows or hides the UI component depending on the argument. */ toggle(showing: boolean): DevExpress.core.utils.DxPromise; } /** * Configures UI component visibility animations. This object contains two fields: show and hide. * @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 dxOverlayAnimation { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; } /** * * @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 dxOverlayOptions extends WidgetOptions { /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: dxOverlayAnimation; /** * Specifies a custom template for the UI component content. */ contentTemplate?: | template | (( contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately. */ deferRendering?: boolean; /** * Specifies the global attributes to be attached to the UI component's container element. * @deprecated */ elementAttr?: any; /** * Specifies whether to hide the UI component if a user clicks outside it. */ hideOnOutsideClick?: | boolean | (( event: DevExpress.events.DxEvent ) => boolean); /** * Specifies whether to hide the widget when users scroll one of its parent elements. */ hideOnParentScroll?: boolean; /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies the maximum height the UI component can reach while resizing. */ maxHeight?: number | string; /** * Specifies the maximum width the UI component can reach while resizing. */ maxWidth?: number | string; /** * Specifies the minimum height the UI component can reach while resizing. */ minHeight?: number | string; /** * Specifies the minimum width the UI component can reach while resizing. */ minWidth?: number | string; /** * A function that is executed after the UI component is hidden. */ onHidden?: (e: DevExpress.common.core.events.EventInfo) => void; /** * A function that is executed before the UI component is hidden. */ onHiding?: ( e: DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo ) => void; /** * A function that is executed before the UI component is displayed. */ onShowing?: ( e: DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo ) => void; /** * A function that is executed after the UI component is displayed. */ onShown?: (e: DevExpress.common.core.events.EventInfo) => void; /** * Positions the UI component. */ position?: any; /** * Specifies whether to shade the background when the UI component is active. */ shading?: boolean; /** * Specifies the shading color. Applies only if shading is enabled. */ shadingColor?: string; /** * A Boolean value specifying whether or not the UI component is visible. */ visible?: boolean; /** * Specifies the UI component's width. */ width?: number | string; /** * Specifies the global attributes for the UI component's wrapper element. */ wrapperAttr?: any; } /** * Pagination is a UI component that allows users to navigate through pages and change page size at runtime. Pagination UI includes a page navigator and several optional elements: a page size selector, navigation buttons, and page information. */ export class dxPagination extends Widget { /** * Gets the number of pages. */ getPageCount(): number; } module dxPagination { export type PageSize = number | 'all'; export type Properties = dxPaginationOptions; } /** * * @deprecated */ export interface dxPaginationOptions extends DevExpress.common.PagerBase, WidgetOptions { /** * Specifies the page index. */ pageIndex?: number; /** * Specifies the page size. */ pageSize?: number; /** * Specifies the total number of items. */ itemCount?: number; /** * Specifies page sizes available in the page size selector. */ allowedPageSizes?: Array; } /** * The PivotGrid is a UI component that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube. */ export class dxPivotGrid extends Widget { /** * Binds a Chart to the PivotGrid. */ bindChart( chart: string | DevExpress.core.DxElement | any, integrationOptions: { inverted?: boolean; dataFieldsDisplayMode?: string; putDataFieldsInto?: string; alternateDataFields?: boolean; processCell?: Function; customizeChart?: Function; customizeSeries?: Function; } ): Function & null; /** * Gets the PivotGridDataSource instance. */ getDataSource(): DevExpress.data.PivotGridDataSource; /** * Gets the Popup instance of the field chooser window. */ getFieldChooserPopup(): dxPopup; /** * Updates the UI component to the size of its content. */ updateDimensions(): void; } module dxPivotGrid { /** * The type of the cellClick event handler's argument. */ export type CellClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxPivotGrid, MouseEvent | PointerEvent > & { /** * */ readonly area?: string; /** * */ readonly cellElement?: DevExpress.core.DxElement; /** * */ readonly cell?: Cell; /** * */ readonly rowIndex?: number; /** * */ readonly columnIndex?: number; /** * */ readonly columnFields?: Array; /** * */ readonly rowFields?: Array; /** * */ readonly dataFields?: Array; }; /** * The type of the cellPrepared event handler's argument. */ export type CellPreparedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly area?: string; /** * */ readonly cellElement?: DevExpress.core.DxElement; /** * */ readonly cell?: Cell; /** * */ readonly rowIndex?: number; /** * */ readonly columnIndex?: number; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contextMenuPreparing event handler's argument. */ export type ContextMenuPreparingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly area?: string; /** * */ readonly cell?: Cell; /** * */ readonly cellElement?: DevExpress.core.DxElement; /** * */ readonly columnIndex?: number; /** * */ readonly rowIndex?: number; /** * */ readonly dataFields?: Array; /** * */ readonly rowFields?: Array; /** * */ readonly columnFields?: Array; /** * */ readonly field?: DevExpress.data.PivotGridDataSource.Field; /** * */ items?: Array; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ fileName?: string; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type PivotGridDataFieldArea = 'column' | 'row'; export type PivotGridRowHeaderLayout = 'standard' | 'tree'; export type PivotGridTotalDisplayMode = | 'both' | 'columns' | 'none' | 'rows'; export type Properties = dxPivotGridOptions; } /** * A complementary UI component for the PivotGrid that allows you to manage data displayed in the PivotGrid. The field chooser is already integrated in the PivotGrid and can be invoked using the context menu. If you need to continuously display the field chooser near the PivotGrid UI component, use the PivotGridFieldChooser UI component. */ export class dxPivotGridFieldChooser extends Widget { /** * Applies changes made in the UI component to the PivotGrid. Takes effect only if applyChangesMode is 'onDemand'. */ applyChanges(): void; /** * Cancels changes made in the UI component without applying them to the PivotGrid. Takes effect only if applyChangesMode is 'onDemand'. */ cancelChanges(): void; /** * Gets the PivotGridDataSource instance. */ getDataSource(): DevExpress.data.PivotGridDataSource; /** * Updates the UI component to the size of its content. */ updateDimensions(): void; } module dxPivotGridFieldChooser { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contextMenuPreparing event handler's argument. */ export type ContextMenuPreparingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly area?: string; /** * */ readonly field?: DevExpress.data.PivotGridDataSource.Field; /** * */ readonly event?: DevExpress.events.DxEvent; /** * */ items?: Array; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxPivotGridFieldChooserOptions; } /** * * @deprecated * @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 dxPivotGridFieldChooserOptions extends WidgetOptions { /** * Specifies whether the field chooser allows search operations in the 'All Fields' section. */ allowSearch?: boolean; /** * Specifies when to apply changes made in the UI component to the PivotGrid. */ applyChangesMode?: DevExpress.common.grids.ApplyChangesMode; /** * The data source of a PivotGrid UI component. */ dataSource?: DevExpress.data.PivotGridDataSource | null; /** * Specifies whether HTML tags are displayed as plain text or applied to the values of the header filter. */ encodeHtml?: boolean; /** * Configures the header filter feature. */ headerFilter?: { /** * Specifies whether searching is enabled in the header filter. * @deprecated Use search.enabled instead. */ allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies the height of the popup menu containing filtering values. */ height?: number; /** * Configures the header filter's search functionality. */ search?: DevExpress.common.grids.HeaderFilterSearchConfig; /** * Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed. * @deprecated Use search.timeout instead. */ searchTimeout?: number; /** * Specifies whether to show all field values or only those that satisfy the other applied filters. */ showRelevantValues?: boolean; /** * Configures the texts of the popup menu's elements. */ texts?: { /** * Specifies the text of the button that closes the popup menu without applying a filter. */ cancel?: string; /** * Specifies the name of the item that represents empty values in the popup menu. */ emptyValue?: string; /** * Specifies the text of the button that applies a filter. */ ok?: string; }; /** * Specifies the width of the popup menu containing filtering values. */ width?: number; }; /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies the field chooser layout. */ layout?: DevExpress.common.FieldChooserLayout; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxPivotGridFieldChooser.ContextMenuPreparingEvent ) => void; /** * Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed. */ searchTimeout?: number; /** * The UI component's state. */ state?: any; /** * Strings that can be changed or localized in the PivotGridFieldChooser UI component. */ texts?: { /** * The string to display instead of All Fields. */ allFields?: string; /** * The string to display instead of Column Fields. */ columnFields?: string; /** * The string to display instead of Data Fields. */ dataFields?: string; /** * The string to display instead of Filter Fields. */ filterFields?: string; /** * The string to display instead of Row Fields. */ rowFields?: string; }; } /** * * @deprecated * @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 dxPivotGridOptions extends WidgetOptions { /** * Allows users to expand/collapse all header items within the same header level. Ignored if the PivotGridDataSource's paginate property is true. */ allowExpandAll?: boolean; /** * Allows a user to filter fields by selecting or deselecting values in the popup menu. */ allowFiltering?: boolean; /** * Allows an end user to change sorting properties. */ allowSorting?: boolean; /** * Allows users to sort the pivot grid by summary values instead of field values. Ignored if the PivotGridDataSource's paginate property is true. */ allowSortingBySummary?: boolean; /** * Specifies the area to which data field headers must belong. */ dataFieldArea?: DevExpress.ui.dxPivotGrid.PivotGridDataFieldArea; /** * Binds the UI component to data. */ dataSource?: | Array | DevExpress.data.PivotGridDataSource | DevExpress.data.PivotGridDataSource.Options | null; /** * Specifies whether HTML tags are displayed as plain text or applied to cell values. */ encodeHtml?: boolean; /** * Configures client-side exporting. */ export?: { /** * Enables client-side exporting. */ enabled?: boolean; }; /** * The Field Chooser configuration properties. */ fieldChooser?: { /** * Specifies whether the field chooser allows search operations in the 'All Fields' section. */ allowSearch?: boolean; /** * Specifies when to apply changes made in the field chooser to the PivotGrid. */ applyChangesMode?: DevExpress.common.grids.ApplyChangesMode; /** * Enables or disables the field chooser. */ enabled?: boolean; /** * Specifies the field chooser height. */ height?: number; /** * Specifies the field chooser layout. */ layout?: DevExpress.common.FieldChooserLayout; /** * Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed. */ searchTimeout?: number; /** * Strings that can be changed or localized in the pivot grid's integrated Field Chooser. */ texts?: { /** * The string to display instead of All Fields. */ allFields?: string; /** * The string to display instead of Column Fields. */ columnFields?: string; /** * The string to display instead of Data Fields. */ dataFields?: string; /** * The string to display instead of Filter Fields. */ filterFields?: string; /** * The string to display instead of Row Fields. */ rowFields?: string; }; /** * Specifies the text to display as a title of the field chooser popup window. */ title?: string; /** * Specifies the field chooser width. */ width?: number; }; /** * Configures the field panel. */ fieldPanel?: { /** * Makes fields on the field panel draggable. */ allowFieldDragging?: boolean; /** * Shows/hides column fields on the field panel. */ showColumnFields?: boolean; /** * Shows/hides data fields on the field panel. */ showDataFields?: boolean; /** * Shows/hides filter fields on the field panel. */ showFilterFields?: boolean; /** * Shows/hides row fields on the field panel. */ showRowFields?: boolean; /** * Specifies the placeholders of the field areas. */ texts?: { /** * Specifies the placeholder of the column field area. */ columnFieldArea?: string; /** * Specifies the placeholder of the data field area. */ dataFieldArea?: string; /** * Specifies the placeholder of the filter field area. */ filterFieldArea?: string; /** * Specifies the placeholder of the row field area. */ rowFieldArea?: string; }; /** * Shows/hides the field panel. */ visible?: boolean; }; /** * Configures the header filter feature. */ headerFilter?: { /** * Specifies whether searching is enabled in the header filter. * @deprecated Use search.enabled instead. */ allowSearch?: boolean; /** * Specifies whether a 'Select All' option is available to users. */ allowSelectAll?: boolean; /** * Specifies the height of the popup menu containing filtering values. */ height?: number; /** * Configures the header filter's search functionality. */ search?: DevExpress.common.grids.HeaderFilterSearchConfig; /** * Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed. * @deprecated Use search.timeout instead. */ searchTimeout?: number; /** * Specifies whether to show all field values or only those that satisfy the other applied filters. */ showRelevantValues?: boolean; /** * Configures the texts of the popup menu's elements. */ texts?: { /** * Specifies the text of the button that closes the popup menu without applying a filter. */ cancel?: string; /** * Specifies the name of the item that represents empty values in the popup menu. */ emptyValue?: string; /** * Specifies the text of the button that applies a filter. */ ok?: string; }; /** * Specifies the width of the popup menu containing filtering values. */ width?: number; }; /** * Specifies whether or not to hide rows and columns with no data. */ hideEmptySummaryCells?: boolean; /** * Specifies properties configuring the load panel. */ loadPanel?: { /** * Enables or disables the load panel. */ enabled?: boolean; /** * Specifies the height of the load panel. */ height?: number; /** * Specifies the URL pointing to an image that will be used as a load indicator. */ indicatorSrc?: string; /** * Specifies whether to shade the UI component when the load panel appears. */ shading?: boolean; /** * Specifies the shading color. Applies only if shading is true. */ shadingColor?: string; /** * Specifies whether or not to show a load indicator. */ showIndicator?: boolean; /** * Specifies whether or not to show load panel background. */ showPane?: boolean; /** * Specifies the text to display inside a load panel. */ text?: string; /** * Specifies the width of the load panel. */ width?: number; }; /** * A function that is executed when a pivot grid cell is clicked or tapped. */ onCellClick?: (e: DevExpress.ui.dxPivotGrid.CellClickEvent) => void; /** * A function that is executed after a pivot grid cell is created. */ onCellPrepared?: (e: DevExpress.ui.dxPivotGrid.CellPreparedEvent) => void; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxPivotGrid.ContextMenuPreparingEvent ) => void; /** * A function that is executed before data is exported. */ onExporting?: (e: DevExpress.ui.dxPivotGrid.ExportingEvent) => void; /** * Specifies the layout of items in the row header. */ rowHeaderLayout?: DevExpress.ui.dxPivotGrid.PivotGridRowHeaderLayout; /** * A configuration object specifying scrolling properties. */ scrolling?: { /** * Specifies the scrolling mode. */ mode?: DevExpress.common.ScrollMode; /** * Specifies whether or not the UI component uses native scrolling. */ useNative?: boolean | DevExpress.common.Mode; }; /** * Specifies whether the outer borders of the grid are visible or not. */ showBorders?: boolean; /** * Specifies whether to display the Grand Total column. */ showColumnGrandTotals?: boolean; /** * Specifies whether to display the Total columns. */ showColumnTotals?: boolean; /** * Specifies whether to display the Grand Total row. */ showRowGrandTotals?: boolean; /** * Specifies whether to display the Total rows. Applies only if rowHeaderLayout is 'standard'. */ showRowTotals?: boolean; /** * Specifies where to show the total rows or columns. */ showTotalsPrior?: DevExpress.ui.dxPivotGrid.PivotGridTotalDisplayMode; /** * A configuration object specifying properties related to state storing. */ stateStoring?: { /** * Specifies a function that is executed on state loading. Applies only if the type is 'custom'. */ customLoad?: () => PromiseLike; /** * Specifies a function that is executed on state change. Applies only if the type is 'custom'. */ customSave?: (state: any) => any; /** * Specifies whether or not a grid saves its state. */ enabled?: boolean; /** * Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds. */ savingTimeout?: number; /** * Specifies a unique key to be used for storing the grid state. */ storageKey?: string; /** * Specifies the type of storage to be used for state storing. */ type?: DevExpress.common.grids.StateStoreType; }; /** * Strings that can be changed or localized in the PivotGrid UI component. */ texts?: { /** * The string to display as a Collapse All context menu item. */ collapseAll?: string; /** * Specifies text displayed in a cell when its data is unavailable for some reason. */ dataNotAvailable?: string; /** * The string to display as an Expand All context menu item. */ expandAll?: string; /** * The string to display as an Export to Excel file context menu item. */ exportToExcel?: string; /** * The string to display as a header of the Grand Total row and column. */ grandTotal?: string; /** * Specifies the text displayed when a pivot grid does not contain any fields. */ noData?: string; /** * The string to display as a Remove All Sorting context menu item. */ removeAllSorting?: string; /** * The string to display as a Show Field Chooser context menu item. */ showFieldChooser?: string; /** * The string to display as a Sort Column by Summary Value context menu item. */ sortColumnBySummary?: string; /** * The string to display as a Sort Row by Summary Value context menu item. */ sortRowBySummary?: string; /** * The string to display as a header of the Total row and column. */ total?: string; }; /** * Specifies whether long text in header items should be wrapped. */ wordWrapEnabled?: boolean; } /** * @deprecated Use Cell instead * @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 dxPivotGridPivotGridCell { /** * The cell's column path. Available for data area cells only. */ columnPath?: Array; /** * The type of the column to which the cell belongs. Available for data area cells only. */ columnType?: 'D' | 'T' | 'GT'; /** * The data field's index. Available for data area cells only. */ dataIndex?: number; /** * Indicates whether the cell is expanded. Available for row or column area cells only. */ expanded?: boolean; /** * The path to the row/column cell. Available for row or column area cells only. */ path?: Array; /** * The cell's row path. Available for data area cells only. */ rowPath?: Array; /** * The type of the row to which the cell belongs. Available for data area cells only. */ rowType?: 'D' | 'T' | 'GT'; /** * The text displayed in the cell. */ text?: string; /** * The cell's type. Available for row or column area cells only. */ type?: 'D' | 'T' | 'GT'; /** * The cell's value. */ value?: any; } /** * An object exposing methods that manipulate a summary cell and provide access to its neighboring cells. * @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 dxPivotGridSummaryCell { /** * Gets the child cell in a specified direction. */ child( direction: string, fieldValue: number | string ): dxPivotGridSummaryCell; /** * Gets all child cells in a specified direction. */ children(direction: string): Array; /** * Gets a pivot grid field that corresponds to the summary cell. */ field(area: string): DevExpress.data.PivotGridDataSource.Field; /** * Gets the Grand Total of the entire pivot grid. */ grandTotal(): dxPivotGridSummaryCell; /** * Gets a partial Grand Total cell of a row or column. */ grandTotal(direction: string): dxPivotGridSummaryCell; /** * Indicates whether the summaryDisplayMode or calculateSummaryValue post-processed the summary value. */ isPostProcessed( field: DevExpress.data.PivotGridDataSource.Field | string ): boolean; /** * Gets the cell next to the current one in a specified direction. */ next(direction: string): dxPivotGridSummaryCell; /** * Gets the cell next to current in a specified direction. */ next(direction: string, allowCrossGroup: boolean): dxPivotGridSummaryCell; /** * Gets the parent cell in a specified direction. */ parent(direction: string): dxPivotGridSummaryCell; /** * Gets the cell prior to the current one in a specified direction. */ prev(direction: string): dxPivotGridSummaryCell; /** * Gets the cell previous to current in a specified direction. */ prev(direction: string, allowCrossGroup: boolean): dxPivotGridSummaryCell; /** * Gets the cell located by the path of the source cell with one field value changed. */ slice( field: DevExpress.data.PivotGridDataSource.Field, value: number | string ): dxPivotGridSummaryCell; /** * Gets the summary cell value. */ value(): any; /** * Gets the value of any field associated with the summary cell. */ value(field: DevExpress.data.PivotGridDataSource.Field | string): any; /** * Gets the value of any field associated with the summary cell. */ value( field: DevExpress.data.PivotGridDataSource.Field | string, postProcessed: boolean ): any; /** * Gets the summary cell value. */ value(postProcessed: boolean): any; } /** * The Popover is a UI component that shows notifications within a box with an arrow pointing to a specified UI element. */ export class dxPopover< TProperties = DevExpress.ui.dxPopover.Properties > extends dxPopup { show(): DevExpress.core.utils.DxPromise; /** * Shows the UI component for a target element. */ show( target: string | DevExpress.core.UserDefinedElement ): DevExpress.core.utils.DxPromise; } module dxPopover { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hidden event handler's argument. */ export type HiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hiding event handler's argument. */ export type HidingEvent = DevExpress.common.core.events.AsyncCancelable & DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & 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. */ interface PopoverInstance extends dxPopover {} export type Properties = dxPopoverOptions; /** * The type of the showing event handler's argument. */ export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo; /** * The type of the titleRendered event handler's argument. */ export type TitleRenderedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxPopup.TitleRenderedInfo; } /** * Configures UI component visibility animations. This object contains two fields: show and hide. * @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 dxPopoverAnimation extends dxPopupAnimation { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; } /** * * @deprecated * @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 dxPopoverOptions extends dxPopupOptions { /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: dxPopoverAnimation; /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies properties of popover hiding. Ignored if the shading property is set to true. */ hideEvent?: | { /** * The delay in milliseconds after which the UI component is hidden. */ delay?: number | undefined; /** * Specifies the event names on which the UI component is hidden. */ name?: string | undefined; } | string | undefined; /** * Specifies whether to hide the UI component if a user clicks outside the popover window or outside the target element. */ hideOnOutsideClick?: | boolean | (( event: DevExpress.events.DxEvent ) => boolean); /** * Specifies whether to hide the widget when users scroll one of its parent elements. */ hideOnParentScroll?: boolean; /** * An object defining UI component positioning properties. */ position?: | DevExpress.common.Position | DevExpress.common.core.animation.PositionConfig; /** * Specifies whether to shade the background when the UI component is active. */ shading?: boolean; /** * Specifies properties for displaying the UI component. */ showEvent?: | { /** * The delay in milliseconds after which the UI component is displayed. */ delay?: number | undefined; /** * Specifies the event names on which the UI component is shown. */ name?: string | undefined; } | string | undefined; /** * A Boolean value specifying whether or not to display the title in the overlay window. */ showTitle?: boolean; /** * Specifies the element against which to position the widget. If target is `undefined`, the component cannot be displayed. */ target?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies the UI component's width. */ width?: number | string; } /** * The Popup UI component is a pop-up window overlaying the current view. */ export class dxPopup< TProperties = DevExpress.ui.dxPopup.Properties > extends dxOverlay {} module dxPopup { export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type HiddenEvent = DevExpress.common.core.events.EventInfo; export type HidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & 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. */ interface PopupInstance extends dxPopup {} export type Properties = dxPopupOptions; export type ResizeEndEvent = DevExpress.common.core.events.NativeEventInfo< dxPopup, MouseEvent | TouchEvent > & DevExpress.ui.dxResizable.ResizeInfo; export type ResizeEvent = DevExpress.common.core.events.NativeEventInfo< dxPopup, MouseEvent | TouchEvent > & DevExpress.ui.dxResizable.ResizeInfo; export type ResizeStartEvent = DevExpress.common.core.events.NativeEventInfo< dxPopup, MouseEvent | TouchEvent > & DevExpress.ui.dxResizable.ResizeInfo; export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; export type ShownEvent = DevExpress.common.core.events.EventInfo; export type TitleRenderedEvent = DevExpress.common.core.events.EventInfo & TitleRenderedInfo; /** * * @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 TitleRenderedInfo { readonly titleElement: DevExpress.core.DxElement; } export type ToolbarLocation = 'bottom' | 'top'; } /** * * @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 dxPopupAnimation extends dxOverlayAnimation { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; } /** * * @deprecated * @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 dxPopupOptions extends dxOverlayOptions { /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: dxPopupAnimation; /** * Specifies the container in which to render the UI component. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies an element with boundaries within which users can drag and resize the Popup. Ignored if the dragOutsideBoundary property is set to true. */ dragAndResizeArea?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies whether or not to allow a user to drag the popup window. */ dragEnabled?: boolean; /** * Allows users to drag the Popup within the browser window or beyond the window's borders. */ dragOutsideBoundary?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether to display the Popup in full-screen mode. */ fullScreen?: boolean; /** * Specifies the UI component's height. */ height?: number | string; /** * A function that is executed each time the UI component is resized by one pixel. */ onResize?: (e: DevExpress.ui.dxPopup.ResizeEvent) => void; /** * A function that is executed when resizing ends. */ onResizeEnd?: (e: DevExpress.ui.dxPopup.ResizeEndEvent) => void; /** * A function that is executed when resizing starts. */ onResizeStart?: (e: DevExpress.ui.dxPopup.ResizeStartEvent) => void; /** * A function that is executed when the UI component's title is rendered. */ onTitleRendered?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.ui.dxPopup.TitleRenderedInfo ) => void; /** * Positions the UI component. */ position?: | DevExpress.common.PositionAlignment | DevExpress.common.core.animation.PositionConfig | Function; /** * Specifies whether to enable page scrolling when the UI component is visible. */ enableBodyScroll?: boolean; /** * Specifies whether or not an end user can resize the UI component. */ resizeEnabled?: boolean; /** * Specifies whether to display the widget at the initial position when users reopen it. */ restorePosition?: boolean; /** * Specifies whether or not the UI component displays the Close button. */ showCloseButton?: boolean; /** * A Boolean value specifying whether or not to display the title in the popup window. */ showTitle?: boolean; /** * The title in the overlay window. */ title?: string; /** * Specifies a custom template for the UI component title. Does not apply if the title is defined. */ titleTemplate?: | template | (( titleElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Configures toolbar items. */ toolbarItems?: Array; /** * Specifies the UI component's width. */ width?: number | string; } /** * The ProgressBar is a UI component that shows current progress. */ export class dxProgressBar extends dxTrackBar { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxProgressBar.Properties['value']): void; } module dxProgressBar { /** * The type of the complete event handler's argument. */ export type CompleteEvent = DevExpress.common.core.events.NativeEventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxProgressBarOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxProgressBarOptions extends dxTrackBarOptions { /** * A function that is executed when the value reaches the maximum. */ onComplete?: (e: DevExpress.ui.dxProgressBar.CompleteEvent) => void; /** * Specifies whether or not the UI component displays a progress status. */ showStatus?: boolean; /** * Specifies a format for the progress status. */ statusFormat?: string | ((ratio: number, value: number) => string); /** * The current UI component value. */ value?: number | false; } /** * The RadioGroup is a UI component that contains a set of radio buttons and allows an end user to make a single selection from the set. */ export class dxRadioGroup extends Editor { getDataSource(): DevExpress.common.data.DataSource; } module dxRadioGroup { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxRadioGroupOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxRadioGroup, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxRadioGroupOptions extends EditorOptions, DataExpressionMixinOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the radio group layout. */ layout?: DevExpress.common.Orientation; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies the UI component's value. */ value?: any; } /** * The RangeSlider is a UI component that allows an end user to choose a range of numeric values. */ export class dxRangeSlider extends dxTrackBar { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxRangeSlider.Properties['value']): void; } module dxRangeSlider { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxRangeSliderOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxRangeSlider, DevExpress.events.InteractionEvent | UIEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo & { /** * */ readonly start?: number; /** * */ readonly end?: number; /** * */ readonly value?: Array; }; } /** * * @deprecated * @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 dxRangeSliderOptions extends dxSliderBaseOptions { /** * The right edge of the interval currently selected using the range slider. */ end?: number; /** * The value to be assigned to the name attribute of the underlying `` element. */ endName?: string; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: (e: DevExpress.ui.dxRangeSlider.ValueChangedEvent) => void; /** * The left edge of the interval currently selected using the range slider. */ start?: number; /** * The value to be assigned to the name attribute of the underlying `` element. */ startName?: string; /** * Specifies the UI component's value. */ value?: Array; } /** * A base class for editors. */ export class dxRecurrenceEditor extends Editor {} module dxRecurrenceEditor { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & 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 = dxRecurrenceEditorOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @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 dxRecurrenceEditorOptions extends EditorOptions { /** * Specifies the UI component's value. */ value?: string; } /** * The Resizable UI component enables its content to be resizable in the UI. */ export class dxResizable extends DOMComponent {} module dxResizable { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxResizableOptions; /** * The type of the resizeEnd event handler's argument. */ export type ResizeEndEvent = DevExpress.common.core.events.NativeEventInfo< dxResizable, MouseEvent | TouchEvent > & ResizeInfo; /** * The type of the resize event handler's argument. */ export type ResizeEvent = DevExpress.common.core.events.NativeEventInfo< dxResizable, MouseEvent | TouchEvent > & ResizeInfo; export type ResizeHandle = 'bottom' | 'left' | 'right' | 'top' | 'all'; /** * * @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 ResizeInfo { /** * */ readonly width: number; /** * */ readonly height: number; } /** * The type of the resizeStart event handler's argument. */ export type ResizeStartEvent = DevExpress.common.core.events.NativeEventInfo< dxResizable, MouseEvent | TouchEvent > & ResizeInfo; } /** * * @deprecated * @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 dxResizableOptions extends DOMComponentOptions { /** * Specifies the area within which users can resize the UI component. */ area?: string | DevExpress.core.UserDefinedElement | undefined; /** * Specifies which borders of the UI component element are used as a handle. */ handles?: DevExpress.ui.dxResizable.ResizeHandle | string; /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies whether to resize the UI component's content proportionally when you use corner handles. */ keepAspectRatio?: boolean; /** * Specifies the upper height boundary for resizing. */ maxHeight?: number; /** * Specifies the upper width boundary for resizing. */ maxWidth?: number; /** * Specifies the lower height boundary for resizing. */ minHeight?: number; /** * Specifies the lower width boundary for resizing. */ minWidth?: number; /** * A function that is executed each time the UI component is resized by one pixel. */ onResize?: (e: DevExpress.ui.dxResizable.ResizeEvent) => void; /** * A function that is executed when resizing ends. */ onResizeEnd?: (e: DevExpress.ui.dxResizable.ResizeEndEvent) => void; /** * A function that is executed when resizing starts. */ onResizeStart?: (e: DevExpress.ui.dxResizable.ResizeStartEvent) => void; /** * Specifies the UI component's width. */ width?: number | string; } /** * The ResponsiveBox UI component allows you to create an application or a website with a layout adapted to different screen sizes. */ export class dxResponsiveBox< TItem extends DevExpress.ui.dxResponsiveBox.ItemLike = any, TKey = any > extends CollectionWidget< dxResponsiveBoxOptions, TItem, TKey > {} module dxResponsiveBox { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxResponsiveBox >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxResponsiveBox, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxResponsiveBox, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxResponsiveBox, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxResponsiveBoxOptions; } /** * @deprecated Use Item instead * @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 dxResponsiveBoxItem extends CollectionWidgetItem { /** * Specifies the item location and size against the UI component grid. */ location?: | { /** * Specifies which column the element should occupy. Accepts an index from the cols array. */ col?: number; /** * Specifies how many columns the element should span. */ colspan?: number | undefined; /** * Specifies which row the element should occupy. Accepts an index from the rows array. */ row?: number; /** * Specifies how many rows the element should span. */ rowspan?: number | undefined; /** * Decides on which screens the current location settings should be applied to the element. */ screen?: string | undefined; } | Array<{ col?: number; colspan?: number; row?: number; rowspan?: number; screen?: string; }>; } /** * * @deprecated */ export interface dxResponsiveBoxOptions< TItem extends DevExpress.ui.dxResponsiveBox.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Specifies the collection of columns for the grid used to position layout elements. */ cols?: Array<{ /** * The column's base width. Calculated automatically when the singleColumnScreen property arranges all elements in a single column. */ baseSize?: number | string; /** * The column width ratio. */ ratio?: number; /** * Decides on which screens the current column is rendered. */ screen?: string | undefined; /** * A factor that defines how much a column width shrinks relative to the rest of the columns in the container. */ shrink?: number; }>; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the UI component's height. */ height?: number | string; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies the collection of rows for the grid used to position layout elements. */ rows?: Array<{ /** * The row's base height. Calculated automatically when the singleColumnScreen property arranges all elements in a single column. */ baseSize?: number | string; /** * The row height ratio. */ ratio?: number; /** * Decides on which screens the current row is rendered. */ screen?: string | undefined; /** * A factor that defines how much a row height shrinks relative to the rest of the rows in the container. */ shrink?: number; }>; /** * Specifies the function returning the size qualifier depending on the screen's width. */ screenByWidth?: Function; /** * Specifies on which screens all layout elements should be arranged in a single column. Accepts a single or several size qualifiers separated by a space. */ singleColumnScreen?: string; /** * Specifies the UI component's width. */ width?: number | string; } /** * The Scheduler is a UI component that represents scheduled data and allows a user to manage and edit it. */ export class dxScheduler extends Widget { /** * Adds an appointment. */ addAppointment(appointment: Appointment): void; /** * Deletes an appointment from the timetable and its object from the data source. */ deleteAppointment(appointment: Appointment): void; /** * Deletes a recurring appointment occurrence. */ deleteRecurrence( appointmentData: Appointment, date: Date | string, recurrenceEditMode: DevExpress.ui.dxScheduler.RecurrenceEditMode ): void; getDataSource(): DevExpress.common.data.DataSource; /** * Gets the current view's end date. */ getEndViewDate(): Date; /** * Gets the current view's start date. */ getStartViewDate(): Date; /** * Hides an appointment details form. */ hideAppointmentPopup(saveChanges?: boolean): void; /** * Hides an appointment's or cell overflow indicator's tooltip. */ hideAppointmentTooltip(): void; /** * Scrolls the current view to a specified position. Available for all views except 'agenda'. You should specify the height property to use this method. */ scrollTo(date: Date, group?: object, allDay?: boolean): void; /** * Scrolls the current view to a specific day and time. * @deprecated Use the scrollTo(date, group, allDay) method instead. */ scrollToTime(hours: number, minutes: number, date?: Date): void; /** * Shows the appointment details form. */ showAppointmentPopup( appointmentData?: Appointment, createNewAppointment?: boolean, currentAppointmentData?: Appointment ): void; /** * Shows a tooltip for a target element. */ showAppointmentTooltip( appointmentData: Appointment, target: string | DevExpress.core.UserDefinedElement, currentAppointmentData?: Appointment ): void; /** * Updates an appointment. */ updateAppointment(target: Appointment, appointment: Appointment): void; } module dxScheduler { export type AllDayPanelMode = 'all' | 'allDay' | 'hidden'; /** * The type of the appointmentAdded event handler's argument. */ export type AppointmentAddedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData: Appointment; /** * */ readonly error?: Error; }; /** * The type of the appointmentAdding event handler's argument. */ export type AppointmentAddingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData: Appointment; /** * */ cancel: boolean | PromiseLike; }; /** * The type of the appointmentClick event handler's argument. */ export type AppointmentClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxScheduler, KeyboardEvent | MouseEvent | PointerEvent > & TargetedAppointmentInfo & { /** * */ readonly appointmentElement: DevExpress.core.DxElement; }; /** * Information about a cell overflow indicator. */ export type AppointmentCollectorTemplateData = { /** * The count of hidden appointments. */ readonly appointmentCount: number; /** * Initially hidden appointments that are displayed after a user clicks an overflow indicator. */ readonly items: Appointment[]; /** * Indicates whether the overflow indicator is compact. */ readonly isCompact: boolean; }; /** * The type of the appointmentContextMenu event handler's argument. */ export type AppointmentContextMenuEvent = DevExpress.common.core.events.NativeEventInfo< dxScheduler, DevExpress.events.PointerInteractionEvent > & TargetedAppointmentInfo & { /** * */ readonly appointmentElement: DevExpress.core.DxElement; }; /** * The type of the appointmentDblClick event handler's argument. */ export type AppointmentDblClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxScheduler, MouseEvent | PointerEvent > & TargetedAppointmentInfo & { /** * */ readonly appointmentElement: DevExpress.core.DxElement; }; /** * The type of the appointmentDeleted event handler's argument. */ export type AppointmentDeletedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData: Appointment; /** * */ readonly error?: Error; }; /** * The type of the appointmentDeleting event handler's argument. */ export type AppointmentDeletingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData: Appointment; /** * */ cancel: boolean | PromiseLike; }; export type AppointmentDraggingAddEvent = AppointmentDraggingEvent & { readonly fromComponent?: dxSortable | dxDraggable; readonly toComponent?: dxSortable | dxDraggable; readonly toData?: any; }; export type AppointmentDraggingEndEvent = DevExpress.common.core.events.Cancelable & AppointmentDraggingEvent & { readonly fromComponent?: dxSortable | dxDraggable; readonly toComponent?: dxSortable | dxDraggable; readonly toData?: any; readonly toItemData?: 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. */ interface AppointmentDraggingEvent { readonly component: dxScheduler; readonly event?: DevExpress.events.DxEvent; readonly itemData?: any; readonly itemElement?: DevExpress.core.DxElement; readonly fromData?: any; } export type AppointmentDraggingMoveEvent = DevExpress.common.core.events.Cancelable & AppointmentDraggingEvent & { readonly fromComponent?: dxSortable | dxDraggable; readonly toComponent?: dxSortable | dxDraggable; readonly toData?: any; }; export type AppointmentDraggingRemoveEvent = AppointmentDraggingEvent & { readonly fromComponent?: dxSortable | dxDraggable; readonly toComponent?: dxSortable | dxDraggable; }; export type AppointmentDraggingStartEvent = DevExpress.common.core.events.Cancelable & Omit & { itemData?: any; }; /** * The type of the appointmentFormOpening event handler's argument. */ export type AppointmentFormOpeningEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData?: Appointment; /** * */ readonly form: dxForm; /** * */ readonly popup: dxPopup; }; /** * The type of the appointmentRendered event handler's argument. */ export type AppointmentRenderedEvent = DevExpress.common.core.events.EventInfo & TargetedAppointmentInfo & { /** * */ readonly appointmentElement: DevExpress.core.DxElement; }; /** * */ export type AppointmentTemplateData = TargetedAppointmentInfo; /** * Specifies appointments information in AppointmentTooltipShowingEvent. */ export type AppointmentTooltipShowingAppointmentInfo = { readonly appointmentData: Appointment; readonly currentAppointmentData: Appointment; readonly color: PromiseLike; }; /** * The type of the appointmentTooltipShowing event handler's argument. */ export type AppointmentTooltipShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly targetElement: DevExpress.core.DxElement; /** * */ readonly appointments: AppointmentTooltipShowingAppointmentInfo[]; }; /** * */ export type AppointmentTooltipTemplateData = TargetedAppointmentInfo & { /** * */ readonly isButtonClicked: boolean; }; /** * The type of the appointmentUpdated event handler's argument. */ export type AppointmentUpdatedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly appointmentData: Appointment; /** * */ readonly error?: Error; }; /** * The type of the appointmentUpdating event handler's argument. */ export type AppointmentUpdatingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly oldData: any; /** * */ readonly newData: any; /** * */ cancel?: boolean | PromiseLike; }; export type CellAppointmentsLimit = 'auto' | 'unlimited'; /** * The type of the cellClick event handler's argument. */ export type CellClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxScheduler, KeyboardEvent | MouseEvent | PointerEvent > & { /** * */ readonly cellData: any; /** * */ readonly cellElement: DevExpress.core.DxElement; }; /** * The type of the cellContextMenu event handler's argument. */ export type CellContextMenuEvent = DevExpress.common.core.events.NativeEventInfo< dxScheduler, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly cellData: any; /** * */ readonly cellElement: DevExpress.core.DxElement; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; export type DateNavigatorTextInfo = { readonly startDate: Date; readonly endDate: Date; readonly text: string; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSchedulerOptions; export type RecurrenceEditMode = 'dialog' | 'occurrence' | 'series'; export type SchedulerPredefinedDateNavigatorItem = | 'prev' | 'next' | 'dateInterval'; export type SchedulerPredefinedToolbarItem = | 'today' | 'dateNavigator' | 'viewSwitcher'; /** * * @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 TargetedAppointmentInfo { /** * */ readonly appointmentData: Appointment; /** * */ readonly targetedAppointmentData?: Appointment; } export type ViewType = | 'agenda' | 'day' | 'month' | 'timelineDay' | 'timelineMonth' | 'timelineWeek' | 'timelineWorkWeek' | 'week' | 'workWeek'; } /** * @deprecated Use the Scheduler's Appointment type instead * @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 dxSchedulerAppointment = CollectionWidgetItem & { /** * Specifies whether the appointment lasts all day. */ allDay?: boolean; /** * Specifies a detail description of the appointment. */ description?: string; /** * Specifies whether the appointment responds to user interaction. */ disabled?: boolean; /** * Specifies the ending of the appointment. */ endDate?: Date | string; /** * Specifies the time zone for an appointment's endDate. Accepts values from the IANA time zone database. */ endDateTimeZone?: string; /** * Specifies the HTML markup to be inserted into the appointment element. */ html?: string; /** * Specifies the start date and time of one or more appointments to exclude from a series. This property requires that you also set recurrenceRule. */ recurrenceException?: string; /** * Specifies a recurrence rule based on which the Scheduler generates an appointment series. */ recurrenceRule?: string; /** * Specifies the start of the appointment. */ startDate?: Date | string; /** * Specifies the time zone for an appointment's startDate. Accepts values from the IANA time zone database. */ startDateTimeZone?: string; /** * Specifies a template that should be used to render this appointment only. */ template?: template; /** * Specifies the subject of the appointment. */ text?: string; /** * Specifies whether or not an appointment must be displayed. */ visible?: boolean; } & Record; /** * * @deprecated * @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 dxSchedulerOptions extends WidgetOptions { /** * Specifies whether the UI component adapts to small screens. */ adaptivityEnabled?: boolean; /** * Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. */ allDayExpr?: string; /** * Specifies a custom template for cell overflow indicators. */ appointmentCollectorTemplate?: | template | (( data: DevExpress.ui.dxScheduler.AppointmentCollectorTemplateData, collectorElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Configures appointment reordering using drag and drop gestures. */ appointmentDragging?: { /** * Enables automatic scrolling while dragging an appointment beyond the viewport. */ autoScroll?: boolean; /** * A container for custom data. */ data?: any | undefined; /** * Allows you to group several UI components so that users can drag and drop appointments between them. */ group?: string | undefined; /** * A function that is called when a new appointment is added. */ onAdd?: ( e: DevExpress.ui.dxScheduler.AppointmentDraggingAddEvent ) => void; /** * A function that is called when the dragged appointment's position is changed. */ onDragEnd?: ( e: DevExpress.ui.dxScheduler.AppointmentDraggingEndEvent ) => void; /** * A function that is called every time a draggable appointment is moved. */ onDragMove?: ( e: DevExpress.ui.dxScheduler.AppointmentDraggingMoveEvent ) => void; /** * A function that is called when the drag gesture is initialized. */ onDragStart?: ( e: DevExpress.ui.dxScheduler.AppointmentDraggingStartEvent ) => void; /** * A function that is called when a draggable appointment is removed. */ onRemove?: ( e: DevExpress.ui.dxScheduler.AppointmentDraggingRemoveEvent ) => void; /** * Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true. */ scrollSensitivity?: number; /** * Specifies the scrolling speed when dragging an appointment beyond the viewport. Applies only if autoScroll is true. */ scrollSpeed?: number; }; /** * Specifies a custom template for appointments. */ appointmentTemplate?: | template | (( model: DevExpress.ui.dxScheduler.AppointmentTemplateData, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for tooltips displayed when users click an appointment or cell overflow indicator. */ appointmentTooltipTemplate?: | template | (( model: DevExpress.ui.dxScheduler.AppointmentTooltipTemplateData, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies cell duration in minutes. This property's value should divide the interval between startDayHour and endDayHour into even parts. */ cellDuration?: number; /** * Specifies whether or not an end user can scroll the view in both directions at the same time. */ crossScrollingEnabled?: boolean; /** * Specifies the current date. */ currentDate?: Date | number | string; /** * Specifies the displayed view. Accepts name or type of a view available in the views array. */ currentView?: DevExpress.ui.dxScheduler.ViewType | string; /** * Customizes the date navigator's text. */ customizeDateNavigatorText?: | ((info: DevExpress.ui.dxScheduler.DateNavigatorTextInfo) => string) | undefined; /** * Specifies a custom template for table cells. */ dataCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies a custom template for day scale items. */ dateCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the format in which date-time values should be sent to the server. */ dateSerializationFormat?: string | undefined; /** * Specifies the name of the data source item field whose value holds the description of the corresponding appointment. */ descriptionExpr?: string; /** * Specifies a custom template for tooltips displayed when users click a cell overflow indicator. * @deprecated Use the appointmentTooltipTemplate option instead. */ dropDownAppointmentTemplate?: | template | (( itemData: any, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies which editing operations a user can perform on appointments. */ editing?: | boolean | { /** * Specifies whether or not an end user can add appointments. */ allowAdding?: boolean; /** * Specifies whether or not an end user can delete appointments. */ allowDeleting?: boolean; /** * Specifies whether users can drag and drop appointments. */ allowDragging?: boolean; /** * Specifies whether or not an end user can change an appointment duration. note] Resizing a [recurring appointment and choosing 'Edit Series' in the 'Edit Recurring Appointment' popup changes the start date of the recurring appointment series. The component removes all appointments before the modified appointment. */ allowResizing?: boolean; /** * Specifies whether users can edit appointment time zones. */ allowTimeZoneEditing?: boolean; /** * Specifies whether or not an end user can change appointment properties. */ allowUpdating?: boolean; }; /** * Specifies the name of the data source item field that defines the ending of an appointment. */ endDateExpr?: string; /** * Specifies the name of the data source item field that defines the timezone of the appointment end date. */ endDateTimeZoneExpr?: string; /** * Specifies the last hour on the time scale. Accepts integer values from 0 to 24. */ endDayHour?: number; /** * Specifies the first day of a week. Does not apply to the agenda view. */ firstDayOfWeek?: DevExpress.common.FirstDayOfWeek | undefined; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is 'horizontal'. */ groupByDate?: boolean; /** * Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. */ groups?: Array; /** * Specifies the time interval between when the date-time indicator changes its position, in milliseconds. */ indicatorUpdateInterval?: number; /** * The latest date the UI component allows you to select. */ max?: Date | number | string | undefined; /** * Specifies the limit of full-sized appointments displayed per cell. Applies to all views except 'agenda'. */ maxAppointmentsPerCell?: | number | DevExpress.ui.dxScheduler.CellAppointmentsLimit; /** * The earliest date the UI component allows you to select. */ min?: Date | number | string | undefined; /** * Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Available for the Agenda view only. */ noDataText?: string; /** * A function that is executed after an appointment is added to the data source. */ onAppointmentAdded?: ( e: DevExpress.ui.dxScheduler.AppointmentAddedEvent ) => void; /** * A function that is executed before an appointment is added to the data source. */ onAppointmentAdding?: ( e: DevExpress.ui.dxScheduler.AppointmentAddingEvent ) => void; /** * A function that is executed when an appointment is clicked or tapped. */ onAppointmentClick?: | ((e: DevExpress.ui.dxScheduler.AppointmentClickEvent) => void) | string; /** * A function that is executed when a user attempts to open the browser's context menu for an appointment. Allows you to replace this context menu with a custom context menu. */ onAppointmentContextMenu?: | ((e: DevExpress.ui.dxScheduler.AppointmentContextMenuEvent) => void) | string; /** * A function that is executed when an appointment is double-clicked or double-tapped. */ onAppointmentDblClick?: | ((e: DevExpress.ui.dxScheduler.AppointmentDblClickEvent) => void) | string; /** * A function that is executed after an appointment is deleted from the data source. */ onAppointmentDeleted?: ( e: DevExpress.ui.dxScheduler.AppointmentDeletedEvent ) => void; /** * A function that is executed before an appointment is deleted from the data source. */ onAppointmentDeleting?: ( e: DevExpress.ui.dxScheduler.AppointmentDeletingEvent ) => void; /** * Occurs before showing an appointment's tooltip. */ onAppointmentTooltipShowing?: ( e: DevExpress.ui.dxScheduler.AppointmentTooltipShowingEvent ) => void; /** * A function that is executed before an appointment details form appears. Use this function to customize the form. */ onAppointmentFormOpening?: ( e: DevExpress.ui.dxScheduler.AppointmentFormOpeningEvent ) => void; /** * A function that is executed when an appointment is rendered. */ onAppointmentRendered?: ( e: DevExpress.ui.dxScheduler.AppointmentRenderedEvent ) => void; /** * A function that is executed after an appointment is updated in the data source. */ onAppointmentUpdated?: ( e: DevExpress.ui.dxScheduler.AppointmentUpdatedEvent ) => void; /** * A function that is executed before an appointment is updated in the data source. */ onAppointmentUpdating?: ( e: DevExpress.ui.dxScheduler.AppointmentUpdatingEvent ) => void; /** * A function that is executed when a view cell is clicked. */ onCellClick?: | ((e: DevExpress.ui.dxScheduler.CellClickEvent) => void) | string; /** * A function that is executed when a user attempts to open the browser's context menu for a cell. Allows you to replace this context menu with a custom context menu. */ onCellContextMenu?: | ((e: DevExpress.ui.dxScheduler.CellContextMenuEvent) => void) | string; /** * Specifies the edit mode for recurring appointments. */ recurrenceEditMode?: DevExpress.ui.dxScheduler.RecurrenceEditMode; /** * Specifies the name of the data source item field that defines exceptions for the current recurring appointment. */ recurrenceExceptionExpr?: string; /** * Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. */ recurrenceRuleExpr?: string; /** * Specifies whether filtering is performed on the server or client side. */ remoteFiltering?: boolean; /** * Specifies a custom template for resource headers. */ resourceCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies an array of resources available in the scheduler. */ resources?: Array<{ /** * Specifies whether you can assign several resources of this kind to an appointment. */ allowMultiple?: boolean; /** * Specifies the resource object field that is used as a resource color. */ colorExpr?: string; /** * Specifies available resource instances. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies which field from the resource data objects provides values to be displayed in the resource editor. */ displayExpr?: string | ((resource: any) => string); /** * The name of the appointment object field that specifies a resource of this kind. */ fieldExpr?: string; /** * Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind. */ label?: string; /** * Specifies whether appointments are colored like this resource kind. */ useColorAsDefault?: boolean; /** * Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window. */ valueExpr?: string | Function; }>; /** * Configures scrolling. */ scrolling?: dxSchedulerScrolling; /** * The data of the currently selected cells. */ selectedCellData?: Array; /** * Specifies whether to apply shading to cover the timetable up to the current time. */ shadeUntilCurrentTime?: boolean; /** * Specifies the 'All-day' panel's visibility. Setting this property to false hides the panel along with the all-day appointments. */ showAllDayPanel?: boolean; /** * Specifies the current date-time indicator's visibility. */ showCurrentTimeIndicator?: boolean; /** * Specifies the name of the data source item field that defines the start of an appointment. */ startDateExpr?: string; /** * Specifies the name of the data source item field that defines the timezone of the appointment start date. */ startDateTimeZoneExpr?: string; /** * Specifies the first hour on the time scale. Accepts integer values from 0 to 24. */ startDayHour?: number; /** * Specifies the name of the data source item field that holds the subject of an appointment. */ textExpr?: string; /** * Specifies a custom template for time scale items. */ timeCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the time zone for the Scheduler's grid. Accepts values from the IANA time zone database. */ timeZone?: string; /** * Specifies whether a user can switch views using tabs or a drop-down menu. */ useDropDownViewSwitcher?: boolean; /** * Specifies the display mode for the All day panel. */ allDayPanelMode?: DevExpress.ui.dxScheduler.AllDayPanelMode; /** * Specifies the minute offset applied to configured day durations in all views. */ offset?: number; /** * Specifies and configures the views to be available in the view switcher. */ views?: Array< | 'day' | 'week' | 'workWeek' | 'month' | 'timelineDay' | 'timelineWeek' | 'timelineWorkWeek' | 'timelineMonth' | 'agenda' | { /** * Specifies the number of dates that can be shown at a time in the agenda view. */ agendaDuration?: number; /** * Specifies a custom template for cell overflow indicators in this view. */ appointmentCollectorTemplate?: | template | (( data: DevExpress.ui.dxScheduler.AppointmentCollectorTemplateData, collectorElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for appointments. */ appointmentTemplate?: | template | (( model: DevExpress.ui.dxScheduler.AppointmentTemplateData, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for tooltips displayed when users click an appointment or cell overflow indicator in this view. */ appointmentTooltipTemplate?: | template | (( model: DevExpress.ui.dxScheduler.AppointmentTooltipTemplateData, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for tooltips displayed when users click a cell overflow indicator in this view. * @deprecated Use the views.appointmentTooltipTemplate option instead. */ dropDownAppointmentTemplate?: | template | (( itemData: any, itemIndex: number, contentElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * The cell duration in minutes. */ cellDuration?: number; /** * Specifies a custom template for table cells. */ dataCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for date scale items. */ dateCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the last hour on the view's time scale. Accepts integer values from 0 to 24. */ endDayHour?: number; /** * The first day of a week. Does not apply to the agenda view. */ firstDayOfWeek?: DevExpress.common.FirstDayOfWeek | undefined; /** * If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is 'horizontal'. */ groupByDate?: boolean; /** * Arranges resource headers vertically (in a column) or horizontally (in a row). */ groupOrientation?: DevExpress.common.Orientation; /** * The resource kinds by which appointments are grouped. */ groups?: Array; /** * Multiplies the default view interval. Applies to all view types except 'agenda'. */ intervalCount?: number; /** * Specifies the limit of full-sized appointments displayed per cell. Applies to all views except 'agenda'. */ maxAppointmentsPerCell?: | number | DevExpress.ui.dxScheduler.CellAppointmentsLimit; /** * A custom view name displayed in the view switcher. */ name?: string | undefined; /** * Specifies a custom template for resource headers. */ resourceCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the date from which to start counting the view interval. Applies to all view types except 'agenda'. */ startDate?: Date | number | string | undefined; /** * Specifies the first hour on the view's time scale. Accepts integer values from 0 to 24. */ startDayHour?: number; /** * Specifies a custom template for time scale items. */ timeCellTemplate?: | template | (( itemData: any, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * The type of the view. */ type?: DevExpress.ui.dxScheduler.ViewType | undefined; /** * Configures scrolling for a view. */ scrolling?: dxSchedulerScrolling; /** * Specifies the display mode for the All day panel. */ allDayPanelMode?: DevExpress.ui.dxScheduler.AllDayPanelMode; /** * Specifies the minute offset applied to configured day durations in the view. */ offset?: number; } >; /** * Configures the toolbar. */ toolbar?: DevExpress.ui.dxScheduler.Toolbar | undefined; } /** * */ export interface dxSchedulerScrolling { /** * Specifies the scrolling mode. */ mode?: DevExpress.common.ScrollMode; } /** * @deprecated Use DevExpress.ui.dxScheduler.Toolbar instead * @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 dxSchedulerToolbar = DevExpress.ui.dxScheduler.Toolbar; /** * @deprecated Use DevExpress.ui.dxScheduler.ToolbarItem instead * @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 dxSchedulerToolbarItem = DevExpress.ui.dxScheduler.ToolbarItem; /** * A UI component used to display scrollable content. * @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 dxScrollable< TProperties = DevExpress.ui.dxScrollable.Properties > extends DOMComponent { /** * Gets the UI component's height. */ clientHeight(): number; /** * Gets the UI component's width. */ clientWidth(): number; /** * Gets the UI component's content. */ content(): DevExpress.core.DxElement; /** * Scrolls the content by a specific distance. */ scrollBy(distance: number | any): void; /** * Gets the scrollable content's height in pixels. */ scrollHeight(): number; /** * Gets the left scroll offset. */ scrollLeft(): number; /** * Gets the scroll offset. */ scrollOffset(): any; /** * Scrolls the content to a specific position. */ scrollTo(targetLocation: number | any): void; /** * Scrolls content to an element. */ scrollToElement(element: DevExpress.core.UserDefinedElement): void; /** * Gets the top scroll offset. */ scrollTop(): number; /** * Gets the scrollable content's width in pixels. */ scrollWidth(): number; /** * Updates the scrollable contents' dimensions. */ update(): DevExpress.core.utils.DxPromise; } module dxScrollable { /** * @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. */ type Properties = dxScrollableOptions; /** * @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 ScrollableInstance extends dxScrollable {} /** * * @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 ScrollEventInfo extends DevExpress.common.core.events.NativeEventInfo< T, WheelEvent | MouseEvent | Event > { /** * */ readonly scrollOffset?: any; /** * */ readonly reachedLeft?: boolean; /** * */ readonly reachedRight?: boolean; /** * */ readonly reachedTop?: boolean; /** * */ readonly reachedBottom?: 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 interface dxScrollableOptions extends DOMComponentOptions { /** * A Boolean value specifying whether to enable or disable the bounce-back effect. */ bounceEnabled?: boolean; /** * A string value specifying the available scrolling directions. */ direction?: DevExpress.common.ScrollDirection; /** * Specifies whether the UI component responds to user interaction. */ disabled?: boolean; /** * A function that is executed on each scroll gesture. */ onScroll?: ( e: DevExpress.ui.dxScrollable.ScrollEventInfo ) => void; /** * A function that is executed each time the UI component is updated. */ onUpdated?: ( e: DevExpress.ui.dxScrollable.ScrollEventInfo ) => void; /** * A Boolean value specifying whether or not an end user can scroll the UI component content swiping it up or down. Applies only if useNative is false */ scrollByContent?: boolean; /** * Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false. */ scrollByThumb?: boolean; /** * Specifies when the UI component shows the scrollbar. */ showScrollbar?: 'onScroll' | 'onHover' | 'always' | 'never'; /** * Indicates whether to use native or simulated scrolling. */ useNative?: boolean; } /** * The ScrollView is a UI component that enables a user to scroll its content. */ export class dxScrollView extends dxScrollable { /** * Locks the UI component until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown property and the handler assigned to the pullDown event. */ refresh(): void; /** * Notifies the ScrollView that data loading is finished. */ release( preventScrollBottom: boolean ): DevExpress.core.utils.DxPromise; } module dxScrollView { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxScrollViewOptions; /** * The type of the pullDown event handler's argument. */ export type PullDownEvent = DevExpress.common.core.events.EventInfo; /** * The type of the reachBottom event handler's argument. */ export type ReachBottomEvent = DevExpress.common.core.events.EventInfo; /** * The type of the scroll event handler's argument. */ export type ScrollEvent = DevExpress.ui.dxScrollable.ScrollEventInfo; /** * The type of the updated event handler's argument. */ export type UpdatedEvent = DevExpress.ui.dxScrollable.ScrollEventInfo; } /** * * @deprecated * @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 dxScrollViewOptions extends dxScrollableOptions { /** * A function that is executed when the 'pull to refresh' gesture is performed. Supported on mobile devices only. */ onPullDown?: (e: DevExpress.ui.dxScrollView.PullDownEvent) => void; /** * A function that is executed when the content is scrolled down to the bottom. */ onReachBottom?: (e: DevExpress.ui.dxScrollView.ReachBottomEvent) => void; /** * Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold. */ pulledDownText?: string; /** * Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold. */ pullingDownText?: string; /** * Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom. */ reachBottomText?: string; /** * Specifies the text shown in the pullDown panel displayed when the content is being refreshed. */ refreshingText?: string; } /** * The SelectBox UI component is an editor that allows an end user to select an item from a drop-down list. */ export class dxSelectBox< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.dxSelectBox.Properties > extends dxDropDownList {} module dxSelectBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, ClipboardEvent >; /** * The type of the customItemCreating event handler's argument. */ export type CustomItemCreatingEvent = DevExpress.common.core.events.EventInfo & CustomItemCreatingInfo; /** * * @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 CustomItemCreatingInfo { /** * */ readonly text?: string; /** * */ customItem?: string | any | PromiseLike; } /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent >; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, ClipboardEvent >; export type Properties = dxSelectBoxOptions; /** * @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 SelectBoxInstance extends dxSelectBox {} /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxDropDownList.SelectionChangedInfo; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxSelectBox, KeyboardEvent | MouseEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxSelectBoxOptions extends dxDropDownListOptions { /** * Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation. */ acceptCustomValue?: boolean; /** * Specifies a custom template for the text field. Must contain the TextBox UI component. */ fieldTemplate?: | template | (( selectedItem: any, fieldElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true. */ onCustomItemCreating?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.ui.dxSelectBox.CustomItemCreatingInfo ) => void; /** * Specifies whether a user can open the drop-down list by clicking a text field. */ openOnFieldClick?: boolean; /** * The text that is provided as a hint in the select box editor. */ placeholder?: string; /** * Specifies whether the drop-down button is visible. */ showDropDownButton?: boolean; /** * Specifies whether or not to display selection controls. */ showSelectionControls?: boolean; /** * Specifies the DOM event after which the custom item should be created. Applies only if acceptCustomValue is enabled. */ customItemCreateEvent?: string; /** * Configures the drop-down field which holds the content. */ dropDownOptions?: DevExpress.ui.dxPopup.Properties; } /** * The Slider is a UI component that allows an end user to set a numeric value on a continuous range of possible values. */ export class dxSlider extends dxTrackBar { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxSlider.Properties['value']): void; } module dxSlider { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSliderOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxSlider, DevExpress.events.InteractionEvent | UIEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * A base class for track bar 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 interface dxSliderBase {} /** * * @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 dxSliderBaseOptions extends dxTrackBarOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the step by which a handle moves when a user presses Page Up or Page Down. */ keyStep?: number; /** * Configures the labels displayed at the min and max values. */ label?: { /** * Formats a value before it is displayed in a label. */ format?: DevExpress.common.core.localization.Format; /** * Specifies whether labels are over or under the scale. */ position?: DevExpress.common.VerticalEdge; /** * Specifies whether slider labels are visible. */ visible?: boolean; }; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies whether to highlight the selected range. */ showRange?: boolean; /** * Specifies the step by which the UI component's value changes when a user drags a handler. */ step?: number; /** * Configures a tooltip. */ tooltip?: { /** * Specifies whether a tooltip is enabled. */ enabled?: boolean; /** * Specifies a tooltip's display format. */ format?: DevExpress.common.core.localization.Format; /** * Specifies whether a tooltip is over or under the slider. */ position?: DevExpress.common.VerticalEdge; /** * Specifies when the UI component shows a tooltip. */ showMode?: DevExpress.common.TooltipShowMode; }; /** * Specifies when to change the component's value. */ valueChangeMode?: DevExpress.common.SliderValueChangeMode; } /** * * @deprecated * @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 dxSliderOptions extends dxSliderBaseOptions { /** * The current slider value. */ value?: number; } /** * Sortable is a user interface utility that allows a UI component's items to be reordered via drag and drop gestures. */ export class dxSortable extends DOMComponent implements DraggableBase { /** * Updates Sortable's dimensions. Call this method after items are added or their dimensions are changed during dragging. */ update(): void; } module dxSortable { /** * The type of the add event handler's argument. */ export interface AddEvent { /** * */ readonly component: dxSortable; /** * */ readonly element: DevExpress.core.DxElement; /** * */ readonly model?: any; /** * */ readonly event: DevExpress.events.DxEvent; /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; /** * */ readonly dropInsideItem: boolean; } /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the dragChange event handler's argument. */ export type DragChangeEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex?: number; /** * */ readonly toIndex?: number; /** * */ readonly fromComponent?: dxSortable | dxDraggable; /** * */ readonly toComponent?: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; /** * */ readonly dropInsideItem?: boolean; }; /** * The type of the dragEnd event handler's argument. */ export type DragEndEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; /** * */ readonly dropInsideItem: boolean; }; /** * The type of the dragMove event handler's argument. */ export type DragMoveEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; /** * */ readonly dropInsideItem: boolean; }; /** * The type of the dragStart event handler's argument. */ export type DragStartEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly fromData?: any; }; export interface DragTemplateData { readonly itemData?: any; readonly itemElement: DevExpress.core.DxElement; readonly fromIndex: number; } /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSortableOptions; /** * The type of the remove event handler's argument. */ export type RemoveEvent = DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; }; /** * The type of the reorder event handler's argument. */ export type ReorderEvent = DevExpress.common.core.events.NativeEventInfo< dxSortable, DevExpress.events.PointerInteractionEvent > & { /** * */ readonly itemData?: any; /** * */ readonly itemElement: DevExpress.core.DxElement; /** * */ readonly fromIndex: number; /** * */ readonly toIndex: number; /** * */ readonly fromComponent: dxSortable | dxDraggable; /** * */ readonly toComponent: dxSortable | dxDraggable; /** * */ readonly fromData?: any; /** * */ readonly toData?: any; /** * */ readonly dropInsideItem: boolean; /** * */ promise?: PromiseLike; }; } /** * * @deprecated * @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 dxSortableOptions extends DraggableBaseOptions { /** * Allows a user to drop an item inside another item. */ allowDropInsideItem?: boolean; /** * Allows a user to reorder sortable items. */ allowReordering?: boolean; /** * Specifies custom markup to be shown instead of the item being dragged. */ dragTemplate?: | template | (( dragInfo: DevExpress.ui.dxSortable.DragTemplateData, containerElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies how to highlight the item's drop position. */ dropFeedbackMode?: DevExpress.common.DragHighlight; /** * Specifies a CSS selector for the items that can be dragged. */ filter?: string; /** * Notifies the UI component of the items' orientation. */ itemOrientation?: DevExpress.common.Orientation; /** * Moves an element in the HTML markup when it is dropped. */ moveItemOnDrop?: boolean; /** * A function that is called when a new item is added. */ onAdd?: (e: DevExpress.ui.dxSortable.AddEvent) => void; /** * A function that is called when the dragged item's position in the list is changed. */ onDragChange?: (e: DevExpress.ui.dxSortable.DragChangeEvent) => void; /** * A function that is called when the drag gesture is finished. */ onDragEnd?: (e: DevExpress.ui.dxSortable.DragEndEvent) => void; /** * A function that is called every time a draggable item is moved. */ onDragMove?: (e: DevExpress.ui.dxSortable.DragMoveEvent) => void; /** * A function that is called when a drag gesture is initialized. */ onDragStart?: (e: DevExpress.ui.dxSortable.DragStartEvent) => void; /** * A function that is called when a draggable item is removed. */ onRemove?: (e: DevExpress.ui.dxSortable.RemoveEvent) => void; /** * A function that is called when the draggable items are reordered. */ onReorder?: (e: DevExpress.ui.dxSortable.ReorderEvent) => void; } /** * The SpeedDialAction is a button that performs a custom action. It can be represented by a Floating Action Button (FAB) or a button in a speed dial menu opened with the FAB. */ export class dxSpeedDialAction extends Widget {} module dxSpeedDialAction { /** * The type of the click event handler's argument. */ export type ClickEvent = DevExpress.common.core.events.NativeEventInfo< dxSpeedDialAction, MouseEvent | PointerEvent > & { /** * */ actionElement?: DevExpress.core.DxElement; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo & { /** * */ actionElement?: DevExpress.core.DxElement; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSpeedDialActionOptions; } /** * * @deprecated * @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 dxSpeedDialActionOptions extends WidgetOptions { /** * Specifies the icon the FAB or speed dial action button displays. */ icon?: string; /** * Allows you to reorder action buttons in the speed dial menu. */ index?: number; /** * Specifies the text label displayed inside the FAB or near the speed dial action button. */ label?: string; /** * A function that is executed when the FAB or speed dial action button is clicked or tapped. */ onClick?: (e: DevExpress.ui.dxSpeedDialAction.ClickEvent) => void; /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ onContentReady?: ( e: DevExpress.ui.dxSpeedDialAction.ContentReadyEvent ) => void; /** * Allows you to hide the FAB from the view or the action from the speed dial menu. */ visible?: boolean; } /** * Splitter is a UI component that allows you to divide a page or section into multiple adjustable panes. */ export class dxSplitter< TItem extends DevExpress.ui.dxSplitter.ItemLike = any, TKey = any > extends CollectionWidget< DevExpress.ui.dxSplitter.Properties, TItem, TKey > {} module dxSplitter { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes, TKey> = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxSplitter >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxSplitter, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemCollapsed event handler's argument. */ export type ItemCollapsedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.InteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemExpanded event handler's argument. */ export type ItemExpandedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.InteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxSplitterOptions; /** * The type of the resizeEnd event handler's argument. */ export type ResizeEndEvent = DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.InteractionEvent > & ResizeInfo; /** * The type of the resize event handler's argument. */ export type ResizeEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.InteractionEvent > & ResizeInfo; /** * * @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 ResizeInfo { /** * A resize handle element. */ readonly handleElement?: DevExpress.core.DxElement; } /** * The type of the resizeStart event handler's argument. */ export type ResizeStartEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxSplitter, DevExpress.events.InteractionEvent > & ResizeInfo; } /** * @deprecated Use Item instead * @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 dxSplitterItem extends CollectionWidgetItem { /** * Specifies a splitter inside an item (pane). */ splitter?: DevExpress.ui.dxSplitter.Properties | undefined; /** * Specifies the initial size of an item (pane) in pixels or as a percentage. The size changes after any layout alteration. */ size?: number | string | undefined; /** * Specifies the maximum size of an item (pane) in pixels or as a percentage. */ maxSize?: number | string | undefined; /** * Specifies the minimum size of an item (pane) in pixels or as a percentage. */ minSize?: number | string | undefined; /** * Specifies the size of a collapsible item (pane) when collapsed in pixels or as a percentage. */ collapsedSize?: number | string | undefined; /** * Specifies whether an item (pane) is initially collapsed. */ collapsed?: boolean; /** * Specifies whether an item (pane) is collapsible. */ collapsible?: boolean; /** * Specifies whether an item (pane) is resizable. */ resizable?: boolean; } /** * * @deprecated */ export interface dxSplitterOptions< TItem extends DevExpress.ui.dxSplitter.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies item orientation (layout). */ orientation?: DevExpress.common.Orientation; /** * An array of items (panes) displayed by the UI component. */ items?: Array; /** * Specifies whether to allow the Splitter to take focus and allow keyboard navigation. */ allowKeyboardNavigation?: boolean; /** * Specifies the size of a separator bar in pixels. */ separatorSize?: number; /** * A function that is executed each time an item (pane) is resized by one pixel. */ onResize?: (e: DevExpress.ui.dxSplitter.ResizeEvent) => void; /** * A function that is called when resizing ends. */ onResizeEnd?: (e: DevExpress.ui.dxSplitter.ResizeEndEvent) => void; /** * A function that is called when resizing starts. */ onResizeStart?: (e: DevExpress.ui.dxSplitter.ResizeStartEvent) => void; /** * A function that is executed after an item (pane) is expanded. */ onItemExpanded?: (e: DevExpress.ui.dxSplitter.ItemExpandedEvent) => void; /** * A function that is executed after an item (pane) is collapsed. */ onItemCollapsed?: (e: DevExpress.ui.dxSplitter.ItemCollapsedEvent) => void; } /** * A Stepper is a UI component that displays progress as a user moves through a sequence of steps. */ export class dxStepper< TItem extends DevExpress.ui.dxStepper.ItemLike = any, TKey = any > extends CollectionWidget< DevExpress.ui.dxStepper.Properties, TItem, TKey > {} module dxStepper { /** * The argument type in the disposing event. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; SelectionChangingEvent: SelectionChangingEvent; }; /** * The argument type in the initialized event. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxStepper >; /** * The argument type in the itemClick event. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxStepper, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The argument type in the itemContextMenu event. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxStepper, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The argument type in the itemRendered event. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The argument type in the optionChanged event. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxStepperOptions; /** * The argument type in the selectionChanged event. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; /** * The argument type in the selectionChanging event. */ export type SelectionChangingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.ui.CollectionWidget.SelectionChangingEventBase< dxStepper >; } /** * @deprecated Use Item instead * @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 dxStepperItem extends CollectionWidgetItem { /** * Specifies the indicator icon. */ icon?: string; /** * Specifies the caption displayed next to the step. */ label?: string; /** * Specifies the hint text that appears when an item (step) is hovered over or long-pressed. */ hint?: string; /** * Marks the step as optional. */ optional?: boolean; /** * Specifies a visual indicator for validation. */ isValid?: boolean; } /** * * @deprecated */ export interface dxStepperOptions< TItem extends DevExpress.ui.dxStepper.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Specifies whether Stepper changes its appearance when in the active state (when an end user interacts with it). */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its appearance when a user hovers over it. */ hoverStateEnabled?: boolean; /** * Specifies if items are selected automatically when focused by keyboard. */ selectOnFocus?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the Stepper orientation. */ orientation?: DevExpress.common.Orientation; /** * Specifies a navigation mode (linear/non-linear). */ linear?: boolean; /** * An array of items (steps) displayed by the Stepper component. */ items?: Array; } /** * The Switch is a UI component that can be in two states: 'On' and 'Off'. */ export class dxSwitch extends Editor { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxSwitch.Properties['value']): void; } module dxSwitch { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSwitchOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxSwitch, DevExpress.events.InteractionEvent | UIEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxSwitchOptions extends EditorOptions { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * Specifies the text displayed when the UI component is switched off. */ switchedOffText?: string; /** * Specifies the text displayed when the UI component is switched on. */ switchedOnText?: string; /** * A Boolean value specifying whether the current switch state is 'On' or 'Off'. */ value?: boolean; } /** * The TabPanel is a UI component consisting of the Tabs and MultiView UI components. It automatically synchronizes the selected tab with the currently displayed view, and vice versa. */ export class dxTabPanel< TItem extends DevExpress.ui.dxTabPanel.ItemLike = any, TKey = any > extends CollectionWidget< DevExpress.ui.dxTabPanel.Properties, TItem, TKey > {} module dxTabPanel { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangingEvent: SelectionChangingEvent; SelectionChangedEvent: SelectionChangedEvent; TitleClickEvent: TitleClickEvent; TitleHoldEvent: TitleHoldEvent; TitleRenderedEvent: TitleRenderedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxTabPanel >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabPanel, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabPanel, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabPanel, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxTabPanelOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; /** * The type of the selectionChanging event handler's argument. */ export type SelectionChangingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.ui.CollectionWidget.SelectionChangingEventBase< dxTabPanel >; /** * * @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 TabPanelItemInfo { /** * */ readonly itemData?: TItem; /** * */ readonly itemElement?: DevExpress.core.DxElement; /** * */ readonly itemIndex: number; } /** * The type of the titleClick event handler's argument. */ export type TitleClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabPanel, KeyboardEvent | MouseEvent | PointerEvent > & TabPanelItemInfo; /** * The type of the titleHold event handler's argument. */ export type TitleHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabPanel, DevExpress.events.PointerInteractionEvent > & TabPanelItemInfo; /** * The type of the titleRendered event handler's argument. */ export type TitleRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & TabPanelItemInfo; } /** * @deprecated Use Item instead * @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 dxTabPanelItem extends DevExpress.ui.dxMultiView.Item { /** * Specifies a badge text for the tab. */ badge?: string; /** * Specifies the icon to be displayed in the tab's title. */ icon?: string; /** * Specifies a template that should be used to render the tab for this item only. */ tabTemplate?: | template | (() => string | DevExpress.core.UserDefinedElement); /** * Specifies the item title text displayed on a corresponding tab. */ title?: string; } /** * * @deprecated */ export interface dxTabPanelOptions< TItem extends DevExpress.ui.dxTabPanel.ItemLike = any, TKey = any > extends dxMultiViewBaseOptions, TItem, TKey> { /** * Specifies whether or not to animate the displayed item change. */ animationEnabled?: boolean; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies a custom template for item titles. */ itemTitleTemplate?: | template | (( itemData: TItem, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies icon position relative to the text inside the tab. */ iconPosition?: DevExpress.common.TabsIconPosition; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies the key property used to access data items. Each key value must be unique. */ keyExpr?: string | Function; /** * A function that is executed when a tab is clicked or tapped. */ onTitleClick?: | ((e: DevExpress.ui.dxTabPanel.TitleClickEvent) => void) | string; /** * A function that is executed when a tab has been held for a specified period. */ onTitleHold?: ( e: DevExpress.ui.dxTabPanel.TitleHoldEvent ) => void; /** * A function that is executed after a tab is rendered. */ onTitleRendered?: ( e: DevExpress.ui.dxTabPanel.TitleRenderedEvent ) => void; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly?: boolean; /** * A Boolean value specifying if tabs in the title are scrolled by content. */ scrollByContent?: boolean; /** * A Boolean indicating whether or not to add scrolling support for tabs in the title. */ scrollingEnabled?: boolean; /** * Specifies whether navigation buttons should be available when tabs exceed the UI component's width. */ showNavButtons?: boolean; /** * Specifies the styling mode for the active tab. */ stylingMode?: DevExpress.common.TabsStyle; /** * A Boolean value specifying whether or not to allow users to change the selected index by swiping. */ swipeEnabled?: boolean; /** * Specifies tab position relative to the panel. */ tabsPosition?: DevExpress.common.Position; } /** * The Tabs component is a tab strip used to switch between pages or views. This UI component is included in the TabPanel UI component, but you can use Tabs separately as well. */ export class dxTabs< TItem extends DevExpress.ui.dxTabs.ItemLike = any, TKey = any > extends CollectionWidget< DevExpress.ui.dxTabs.Properties, TItem, TKey > {} module dxTabs { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; SelectionChangedEvent: SelectionChangedEvent; SelectionChangingEvent: SelectionChangingEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabs, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabs, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTabs, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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 ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxTabsBaseOptions, TItem, TKey>; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.ui.CollectionWidget.SelectionChangeInfo; /** * The type of the selectionChanging event handler's argument. */ export type SelectionChangingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.ui.CollectionWidget.SelectionChangingEventBase< dxTabs >; } /** * * @deprecated * @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 dxTabsBaseOptions< TComponent extends dxTabs = dxTabs, TItem extends DevExpress.ui.dxTabs.ItemLike = any, TKey = any > extends CollectionWidgetOptions { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies icon position relative to the text inside the tab. */ iconPosition?: DevExpress.common.TabsIconPosition; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies component orientation. */ orientation?: DevExpress.common.Orientation; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly?: boolean; /** * Specifies whether or not an end user can scroll tabs by swiping. */ scrollByContent?: boolean; /** * Specifies whether or not an end user can scroll tabs. */ scrollingEnabled?: boolean; /** * Specifies whether the UI component enables an end user to select only a single item or multiple items. */ selectionMode?: DevExpress.common.SingleOrMultiple; /** * Specifies whether navigation buttons should be available when tabs exceed the UI component's width. */ showNavButtons?: boolean; /** * Specifies the styling mode for the active tab. */ stylingMode?: DevExpress.common.TabsStyle; } /** * @deprecated Use Item instead * @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 dxTabsItem extends CollectionWidgetItem { /** * Specifies a badge text for the tab. */ badge?: string; /** * Specifies the icon to be displayed on the tab. */ icon?: string; } /** * * @deprecated */ export interface dxTabsOptions< TItem extends DevExpress.ui.dxTabs.ItemLike = any, TKey = any > extends DevExpress.ui.dxTabs.Properties {} /** * The TagBox UI component is an editor that allows an end user to select multiple items from a drop-down list. */ export class dxTagBox extends dxSelectBox { /** * Resets the value property to the value passed as an argument. */ reset(value?: DevExpress.ui.dxTagBox.Properties['value']): void; } module dxTagBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, Event >; /** * The type of the closed event handler's argument. */ export type ClosedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the customItemCreating event handler's argument. */ export type CustomItemCreatingEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.dxSelectBox.CustomItemCreatingInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; export type DropDownButtonTemplateData = DevExpress.ui.dxDropDownEditor.DropDownButtonTemplateDataModel; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo & DevExpress.common.core.events.ItemInfo; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, KeyboardEvent >; /** * The type of the multiTagPreparing event handler's argument. */ export type MultiTagPreparingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo & { /** * */ readonly multiTagElement: DevExpress.core.DxElement; /** * */ readonly selectedItems?: Array; /** * */ text?: string; }; /** * The type of the opened event handler's argument. */ export type OpenedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxTagBoxOptions; /** * The type of the selectAllValueChanged event handler's argument. */ export type SelectAllValueChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly value: boolean; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.ui.CollectionWidget.SelectionChangeInfo< string | number | any >; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxTagBox, KeyboardEvent | MouseEvent | PointerEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxTagBoxOptions extends Pick< dxSelectBoxOptions, Exclude, 'onSelectionChanged'> > { /** * Specifies how the UI component applies values. */ applyValueMode?: DevExpress.common.ApplyValueMode; /** * A Boolean value specifying whether or not to hide selected items. */ hideSelectedItems?: boolean; /** * Specifies the limit on displayed tags. On exceeding it, the UI component replaces all tags with a single multi-tag that displays the number of selected items. */ maxDisplayedTags?: number | undefined; /** * A Boolean value specifying whether or not the UI component is multiline. */ multiline?: boolean; /** * A function that is executed before the multi-tag is rendered. */ onMultiTagPreparing?: ( e: DevExpress.ui.dxTagBox.MultiTagPreparingEvent ) => void; /** * A function that is executed when the 'Select All' check box value is changed. Applies only if showSelectionControls is true. */ onSelectAllValueChanged?: ( e: DevExpress.ui.dxTagBox.SelectAllValueChangedEvent ) => void; /** * A function that is executed when a list item is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.ui.dxTagBox.SelectionChangedEvent ) => void; /** * Specifies the mode in which all items are selected. */ selectAllMode?: DevExpress.common.SelectAllMode; /** * Gets the currently selected items. */ selectedItems?: Array; /** * Specifies the text displayed at the 'Select All' check box. */ selectAllText?: string; /** * Specifies whether the drop-down button is visible. */ showDropDownButton?: boolean; /** * Specifies the maximum filter query length in characters. */ maxFilterQueryLength?: number; /** * Specifies whether the multi-tag is shown without ordinary tags. */ showMultiTagOnly?: boolean; /** * Specifies a custom template for tags. */ tagTemplate?: | template | (( itemData: any, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the selected items. */ value?: Array; } /** * The TextArea is a UI component that enables a user to enter and edit a multi-line text. */ export class dxTextArea extends dxTextBox {} module dxTextArea { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, Event >; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, KeyboardEvent >; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, ClipboardEvent >; export type Properties = dxTextAreaOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxTextArea, DevExpress.events.InteractionEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxTextAreaOptions extends dxTextBoxOptions { /** * A Boolean value specifying whether or not the auto resizing mode is enabled. */ autoResizeEnabled?: boolean; /** * Specifies the maximum height of the UI component. */ maxHeight?: number | string | undefined; /** * Specifies the minimum height of the UI component. */ minHeight?: number | string | undefined; /** * Specifies whether or not the UI component checks the inner text for spelling mistakes. */ spellcheck?: boolean; } /** * The TextBox is a UI component that enables a user to enter and edit a single line of text. */ export class dxTextBox< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.dxTextBox.Properties > extends dxTextEditor { /** * Resets the value property to the value passed as an argument. */ reset(value?: TProperties['value']): void; } module dxTextBox { /** * The type of the change event handler's argument. */ export type ChangeEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, Event >; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the copy event handler's argument. */ export type CopyEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, ClipboardEvent >; /** * The type of the cut event handler's argument. */ export type CutEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, ClipboardEvent >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the enterKey event handler's argument. */ export type EnterKeyEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, KeyboardEvent >; /** * The type of the focusIn event handler's argument. */ export type FocusInEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, FocusEvent >; /** * The type of the focusOut event handler's argument. */ export type FocusOutEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, FocusEvent >; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the input event handler's argument. */ export type InputEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, UIEvent & { target: HTMLInputElement } >; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, KeyboardEvent >; export type KeyPressEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, KeyboardEvent >; /** * The type of the keyUp event handler's argument. */ export type KeyUpEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, KeyboardEvent >; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the paste event handler's argument. */ export type PasteEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, ClipboardEvent >; export type Properties = dxTextBoxOptions; /** * @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 TextBoxInstance extends dxTextBox {} export type TextBoxType = | 'email' | 'password' | 'search' | 'tel' | 'text' | 'url'; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxTextBox, DevExpress.events.InteractionEvent | Event > & DevExpress.ui.Editor.ValueChangedInfo; } /** * * @deprecated * @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 dxTextBoxOptions extends dxTextEditorOptions { /** * Specifies the maximum number of characters you can enter into the textbox. */ maxLength?: string | number; /** * The 'mode' attribute value of the actual HTML input element representing the text box. */ mode?: DevExpress.ui.dxTextBox.TextBoxType; /** * Specifies a value the UI component displays. */ value?: string; } /** * A base class for text editing 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 dxTextEditor< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.dxTextEditor.Properties > extends Editor { /** * Removes focus from the input element. */ blur(): void; /** * Sets focus to the input element representing the UI component. */ focus(): void; /** * Gets an instance of a custom action button. */ getButton(name: string): dxButton | undefined; } module dxTextEditor { /** * @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. */ type Properties = dxTextEditorOptions; /** * @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 TextEditorInstance extends dxTextEditor {} } /** * * @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 dxTextEditorOptions extends EditorOptions { /** * Allows you to add custom buttons to the input text field. */ buttons?: Array< | string | DevExpress.common.TextBoxPredefinedButton | DevExpress.common.TextEditorButton >; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the attributes to be passed on to the underlying HTML element. */ inputAttr?: any; /** * Specifies a text string used to annotate the editor's value. */ label?: string; /** * Specifies the label's display mode. */ labelMode?: DevExpress.common.LabelMode; /** * The editor mask that specifies a custom input format. */ mask?: string; /** * Specifies a mask placeholder. A single character is recommended. */ maskChar?: string; /** * A message displayed when the entered text does not match the specified pattern. */ maskInvalidMessage?: string; /** * Specifies custom mask rules. */ maskRules?: any; /** * The value to be assigned to the `name` attribute of the underlying HTML element. */ name?: string; /** * A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. */ onChange?: ( e: DevExpress.common.core.events.NativeEventInfo ) => void; /** * A function that is executed when the UI component's input has been copied. */ onCopy?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, ClipboardEvent > ) => void; /** * A function that is executed when the UI component's input has been cut. */ onCut?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, ClipboardEvent > ) => void; /** * A function that is executed when the Enter key has been pressed while the UI component is focused. */ onEnterKey?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent > ) => void; /** * A function that is executed when the UI component gets focus. */ onFocusIn?: ( e: DevExpress.common.core.events.NativeEventInfo ) => void; /** * A function that is executed when the UI component loses focus. */ onFocusOut?: ( e: DevExpress.common.core.events.NativeEventInfo ) => void; /** * A function that is executed each time the UI component's input is changed while the UI component is focused. */ onInput?: ( e: DevExpress.common.core.events.NativeEventInfo ) => void; /** * A function that is executed when a user is pressing a key on the keyboard. */ onKeyDown?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent > ) => void; /** * A function that is executed when a user releases a key on the keyboard. */ onKeyUp?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, KeyboardEvent > ) => void; /** * A function that is executed when the UI component's input has been pasted. */ onPaste?: ( e: DevExpress.common.core.events.NativeEventInfo< TComponent, ClipboardEvent > ) => void; /** * Specifies a text string displayed when the editor's value is empty. */ placeholder?: string; /** * Specifies whether to display the Clear button in the UI component. */ showClearButton?: boolean; /** * Specifies when the UI component shows the mask. Applies only if useMaskedValue is true. */ showMaskMode?: DevExpress.common.MaskMode; /** * Specifies whether or not the UI component checks the inner text for spelling mistakes. */ spellcheck?: boolean; /** * Specifies how the UI component's text field is styled. */ stylingMode?: DevExpress.common.EditorStyle; /** * The read-only property that holds the text displayed by the UI component input element. */ text?: string; /** * Specifies whether the value should contain mask characters or not. */ useMaskedValue?: boolean; /** * Specifies the editor's value. */ value?: any; /** * Specifies the DOM events after which the UI component's value should be updated. */ valueChangeEvent?: string; } /** * The TileView UI component contains a collection of tiles. Tiles can store much more information than ordinary buttons, that is why they are very popular in apps designed for touch devices. */ export class dxTileView< TItem extends DevExpress.ui.dxTileView.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> { /** * Gets the current scroll position. */ scrollPosition(): number; } module dxTileView { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxTileView >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTileView, KeyboardEvent | MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTileView, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTileView, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxTileViewOptions; } /** * @deprecated Use Item instead * @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 dxTileViewItem extends CollectionWidgetItem { /** * Specifies a multiplier for the baseItemHeight property value (for the purpose of obtaining the actual item height). */ heightRatio?: number; /** * Specifies a multiplier for the baseItemWidth property value (for the purpose of obtaining the actual item width). */ widthRatio?: number; } /** * * @deprecated */ export interface dxTileViewOptions< TItem extends DevExpress.ui.dxTileView.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies the height of the base tile view item. */ baseItemHeight?: number; /** * Specifies the width of the base tile view item. */ baseItemWidth?: number; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether the UI component is oriented horizontally or vertically. */ direction?: DevExpress.common.Orientation; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies the distance in pixels between adjacent tiles. */ itemMargin?: number; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies when the UI component shows the scrollbar. */ showScrollbar?: DevExpress.common.ScrollbarMode; } /** * The Toast is a UI component that provides pop-up notifications. */ export class dxToast extends dxOverlay {} module dxToast { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hidden event handler's argument. */ export type HiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hiding event handler's argument. */ export type HidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxToastOptions; /** * The type of the showing event handler's argument. */ export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo; export type ToastType = 'custom' | 'error' | 'info' | 'success' | 'warning'; } /** * * @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 dxToastAnimation extends dxOverlayAnimation { /** * An object that defines the animation properties used when the UI component is being hidden. */ hide?: DevExpress.common.core.animation.AnimationConfig; /** * An object that defines the animation properties used when the UI component is being shown. */ show?: DevExpress.common.core.animation.AnimationConfig; } /** * * @deprecated * @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 dxToastOptions extends dxOverlayOptions { /** * Configures UI component visibility animations. This object contains two fields: show and hide. */ animation?: dxToastAnimation; /** * A Boolean value specifying whether or not the toast is closed if a user clicks it. */ closeOnClick?: boolean; /** * A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries. */ closeOnSwipe?: boolean; /** * The time span in milliseconds during which the Toast UI component is visible. */ displayTime?: number; /** * Specifies whether to hide the UI component if a user clicks outside it. */ hideOnOutsideClick?: | boolean | (( event: DevExpress.events.DxEvent ) => boolean); /** * Specifies the UI component's height. */ height?: number | string; /** * Specifies the maximum width the UI component can reach while resizing. */ maxWidth?: number | string; /** * The Toast message text. */ message?: string; /** * Specifies the minimum width the UI component can reach while resizing. */ minWidth?: number | string; /** * Positions the UI component. */ position?: DevExpress.common.core.animation.PositionConfig | string; /** * Specifies whether to shade the background when the UI component is active. */ shading?: boolean; /** * Specifies the Toast UI component type. */ type?: DevExpress.ui.dxToast.ToastType; /** * Specifies the UI component's width. */ width?: number | string; } /** * The Toolbar is a UI component containing items that usually manage screen content. Those items can be plain text or UI components. */ export class dxToolbar< TItem extends DevExpress.ui.dxToolbar.ItemLike = any, TKey = any > extends CollectionWidget, TItem, TKey> {} module dxToolbar { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxToolbar >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxToolbar, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxToolbar, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxToolbar, DevExpress.events.PointerInteractionEvent > & DevExpress.common.core.events.ItemInfo; /** * @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. */ type ItemLike = string | Item | any; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ItemInfo; export type LocateInMenuMode = 'always' | 'auto' | 'never'; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends ItemLike = any, TKey = any > = dxToolbarOptions; export type ShowTextMode = 'always' | 'inMenu'; } /** * @deprecated Use Item instead * @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 dxToolbarItem extends CollectionWidgetItem { /** * Specifies a CSS class to be applied to the item. */ cssClass?: string | undefined; /** * Specifies when to display an item in the toolbar's overflow menu. */ locateInMenu?: DevExpress.ui.dxToolbar.LocateInMenuMode; /** * Specifies a location for the item on the toolbar. */ location?: DevExpress.common.ToolbarItemLocation; /** * Specifies a template that should be used to render a menu item. */ menuItemTemplate?: | template | (() => string | DevExpress.core.UserDefinedElement); /** * Configures the DevExtreme UI component used as a toolbar item. */ options?: any; /** * Specifies when to display the text for the UI component item. */ showText?: DevExpress.ui.dxToolbar.ShowTextMode; /** * A UI component that presents a toolbar item. To configure it, use the options object. */ widget?: DevExpress.common.ToolbarItemComponent; } /** * * @deprecated */ export interface dxToolbarOptions< TItem extends DevExpress.ui.dxToolbar.ItemLike = any, TKey = any > extends CollectionWidgetOptions, TItem, TKey> { /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * An array of items displayed by the UI component. */ items?: Array; /** * Specifies whether or not the Toolbar arranges items into multiple lines when their combined width exceeds the Toolbar width. */ multiline?: boolean; /** * Specifies a custom template for menu items. */ menuItemTemplate?: | template | (( itemData: TItem, itemIndex: number, itemElement: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); } /** * The Tooltip UI component displays a tooltip for a specified element on the page. */ export class dxTooltip extends dxPopover {} module dxTooltip { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hidden event handler's argument. */ export type HiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the hiding event handler's argument. */ export type HidingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxTooltipOptions; /** * The type of the showing event handler's argument. */ export type ShowingEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo; /** * The type of the shown event handler's argument. */ export type ShownEvent = DevExpress.common.core.events.EventInfo; } /** * * @deprecated * @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 dxTooltipOptions extends dxPopoverOptions {} /** * A base class for track bar 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 dxTrackBar< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue > extends Editor {} /** * * @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 dxTrackBarOptions extends EditorOptions { /** * The maximum value the UI component can accept. */ max?: number; /** * The minimum value the UI component can accept. */ min?: number; } /** * The TreeList is a UI component that represents data from a local or remote source in the form of a multi-column tree view. This UI component offers such features as sorting, filtering, editing, selection, etc. */ export class dxTreeList extends Widget> implements DevExpress.common.grids.GridBase { /** * Adds a new column. */ addColumn( columnOptions: DevExpress.ui.dxTreeList.Column | string ): void; /** * Adds an empty data row to the highest hierarchical level and switches it to the editing state. */ addRow(): DevExpress.core.utils.DxPromise; /** * Adds an empty data row to a specified parent row. */ addRow(parentId: TKey): DevExpress.core.utils.DxPromise; /** * Collapses a row with a specific key. */ collapseRow(key: TKey): DevExpress.core.utils.DxPromise; /** * Expands a row with a specific key. */ expandRow(key: TKey): DevExpress.core.utils.DxPromise; /** * Performs a pre-order tree traversal, executing a function on each visited node. Starts traversing from the top level nodes. */ forEachNode(callback: Function): void; /** * Performs a pre-order tree traversal, executing a function on each visited node. Starts traversing from the specified nodes. */ forEachNode( nodes: Array>, callback: Function ): void; /** * Gets a node with a specific key. */ getNodeByKey(key: TKey): DevExpress.ui.dxTreeList.Node; /** * Gets the root node. */ getRootNode(): DevExpress.ui.dxTreeList.Node; /** * Gets the keys of the rows selected explicitly via the API or via a click or tap. */ getSelectedRowKeys(): Array; /** * Gets selected row keys. */ getSelectedRowKeys(mode: string): Array; /** * Gets the data objects of the rows selected explicitly via the API or via a click or tap. */ getSelectedRowsData(): Array; /** * Gets selected row data objects. */ getSelectedRowsData(mode: string): Array; /** * Gets all visible columns. */ getVisibleColumns(): Array>; /** * Gets all visible columns at a specific hierarchical level of column headers. Use it to access banded columns. */ getVisibleColumns( headerLevel: number ): Array>; /** * Gets currently rendered rows. */ getVisibleRows(): Array>; /** * Checks whether a row is expanded or collapsed. */ isRowExpanded(key: TKey): boolean; /** * Loads all root node descendants (all data items). Takes effect only if data has a plain structure and remoteOperations.filtering is set to true. Does not load/reload cached data. */ loadDescendants(): DevExpress.core.utils.DxPromise; /** * Loads specified node descendants. Takes effect only if data has a plain structure and remoteOperations.filtering is set to true. Does not load/reload cached data. */ loadDescendants(keys: Array): DevExpress.core.utils.DxPromise; /** * Loads specified node descendants. Affects all descendants when childrenOnly is set to `false` (default) and only direct descendants when childrenOnly is set to `true`. Takes effect only if data has plain structure and remoteOperations.filtering is set to true. Does not load/reload cached data. */ loadDescendants( keys: Array, childrenOnly: boolean ): DevExpress.core.utils.DxPromise; beginCustomLoading(messageText: string): void; byKey(key: TKey): DevExpress.core.utils.DxPromise; cancelEditData(): void; cellValue(rowIndex: number, dataField: string): any; cellValue(rowIndex: number, dataField: string, value: any): void; cellValue(rowIndex: number, visibleColumnIndex: number): any; cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; clearFilter(): void; clearFilter(filterName: string): void; clearSelection(): void; clearSorting(): void; closeEditCell(): void; collapseAdaptiveDetailRow(): void; columnCount(): number; columnOption(id: number | string): any; columnOption(id: number | string, optionName: string): any; columnOption( id: number | string, optionName: string, optionValue: any ): void; columnOption(id: number | string, options: any): void; deleteColumn(id: number | string): void; deleteRow(rowIndex: number): void; deselectAll(): DevExpress.core.utils.DxPromise; deselectRows( keys: Array ): DevExpress.core.utils.DxPromise>; editCell(rowIndex: number, dataField: string): void; editCell(rowIndex: number, visibleColumnIndex: number): void; editRow(rowIndex: number): void; endCustomLoading(): void; expandAdaptiveDetailRow(key: TKey): void; filter(): any; filter(filterExpr: any): void; focus(): void; focus(element: DevExpress.core.UserDefinedElement): void; getCellElement( rowIndex: number, dataField: string ): DevExpress.core.DxElement | undefined; getCellElement( rowIndex: number, visibleColumnIndex: number ): DevExpress.core.DxElement | undefined; getCombinedFilter(): any; getCombinedFilter(returnDataField: boolean): any; getDataSource(): DevExpress.common.data.DataSource; getKeyByRowIndex(rowIndex: number): TKey | undefined; getRowElement( rowIndex: number ): DevExpress.core.UserDefinedElementsArray | undefined; getRowIndexByKey(key: TKey): number; getScrollable(): DevExpress.ui.dxTreeList.Scrollable; getVisibleColumnIndex(id: number | string): number; hasEditData(): boolean; hideColumnChooser(): void; isAdaptiveDetailRowExpanded(key: TKey): boolean; isRowFocused(key: TKey): boolean; isRowSelected(key: TKey): boolean; keyOf(obj: TRowData): TKey; navigateToRow(key: TKey): DevExpress.core.utils.DxPromise; pageCount(): number; pageIndex(): number; pageIndex(newIndex: number): DevExpress.core.utils.DxPromise; pageSize(): number; pageSize(value: number): void; refresh(): DevExpress.core.utils.DxPromise; refresh(changesOnly: boolean): DevExpress.core.utils.DxPromise; repaintRows(rowIndexes: Array): void; saveEditData(): DevExpress.core.utils.DxPromise; searchByText(text: string): void; selectAll(): DevExpress.core.utils.DxPromise; selectRows( keys: Array, preserve: boolean ): DevExpress.core.utils.DxPromise>; selectRowsByIndexes( indexes: Array ): DevExpress.core.utils.DxPromise>; showColumnChooser(): void; state(): any; state(state: any): void; undeleteRow(rowIndex: number): void; updateDimensions(): void; } module dxTreeList { /** * The type of the adaptiveDetailRowPreparing event handler's argument. */ export type AdaptiveDetailRowPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.AdaptiveDetailRowPreparingInfo; /** * The type of the cellClick event handler's argument. */ export type CellClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, PointerEvent | MouseEvent > & CellInfo; /** * The type of the cellDblClick event handler's argument. */ export type CellDblClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, PointerEvent | MouseEvent > & CellInfo; /** * The type of the cellHoverChanged event handler's argument. */ export type CellHoverChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & CellInfo & { /** * */ readonly eventType: 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 interface CellInfo { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly value?: any; /** * */ readonly displayValue?: any; /** * */ readonly text: string; /** * */ readonly columnIndex: number; /** * */ readonly column: Column; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly row: Row; } /** * The type of the cellPrepared event handler's argument. */ export type CellPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & CellInfo & { /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly watch?: Function; /** * */ readonly oldValue?: any; }; export type Column = dxTreeListColumn< TRowData, TKey >; export type ColumnButton< TRowData = any, TKey = any > = dxTreeListColumnButton; export type ColumnButtonClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, PointerEvent | MouseEvent > & { row?: Row; column?: Column; }; export type ColumnButtonTemplateData = { readonly component: dxTreeList; readonly data: TRowData; readonly key: TKey; readonly columnIndex: number; readonly column: Column; readonly rowIndex: number; readonly rowType: string; readonly row: Row; }; export type ColumnCellTemplateData = { readonly data: TRowData; readonly component: dxTreeList; readonly value?: any; readonly oldValue?: any; readonly displayValue?: any; readonly text: string; readonly columnIndex: number; readonly rowIndex: number; readonly column: Column; readonly row: Row; readonly rowType: string; readonly watch?: Function; }; export type ColumnEditCellTemplateData = { readonly setValue?: any; readonly data: TRowData; readonly component: dxTreeList; readonly value?: any; readonly displayValue?: any; readonly text: string; readonly columnIndex: number; readonly rowIndex: number; readonly column: Column; readonly row: Row; readonly rowType: string; readonly watch?: Function; }; /** * @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 ColumnHeaderCellTemplateData = { readonly component: dxTreeList; readonly columnIndex: number; readonly column: Column; }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * The type of the contextMenuPreparing event handler's argument. */ export type ContextMenuPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ items?: Array; /** * */ readonly target: DevExpress.common.grids.GridsContextMenuTarget; /** * */ readonly targetElement: DevExpress.core.DxElement; /** * */ readonly columnIndex: number; /** * */ readonly column?: Column; /** * */ readonly rowIndex: number; /** * */ readonly row?: Row; }; /** * The type of the dataErrorOccurred event handler's argument. */ export type DataErrorOccurredEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataErrorOccurredInfo; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo>; /** * @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 dxTreeListToolbar = Toolbar; /** * @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 dxTreeListToolbarItem = ToolbarItem; /** * The type of the editCanceled event handler's argument. */ export type EditCanceledEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * The type of the editCanceling event handler's argument. */ export type EditCancelingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * Configures editing. */ export interface Editing extends DevExpress.common.grids.EditingBase { /** * Specifies whether a user can add new rows. It is called for each data row when defined as a function. */ allowAdding?: | boolean | ((options: { readonly component: dxTreeList; readonly row?: Row; }) => boolean); /** * Specifies whether a user can delete rows. It is called for each data row when defined as a function. */ allowDeleting?: | boolean | ((options: { readonly component: dxTreeList; readonly row?: Row; }) => boolean); /** * Specifies whether a user can update rows. It is called for each data row when defined as a function */ allowUpdating?: | boolean | ((options: { readonly component: dxTreeList; readonly row?: Row; }) => boolean); /** * Contains properties that specify texts for editing-related UI elements. */ texts?: EditingTexts; } /** * The type of the editingStart event handler's argument. */ export type EditingStartEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly column: Column; }; /** * Contains properties that specify texts for editing-related UI elements. */ export type EditingTexts = DevExpress.common.grids.EditingTextsBase & { /** * Specifies text for the button that adds a new nested row. Applies if the editing.mode is 'batch' or 'cell'. */ addRowToNode?: string; }; /** * The type of the editorPrepared event handler's argument. */ export type EditorPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly parentType: string; /** * */ readonly value?: any; /** * */ readonly setValue?: any; /** * */ readonly updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; /** * */ readonly editorElement: DevExpress.core.DxElement; /** * */ readonly readOnly: boolean; /** * */ readonly dataField?: string; /** * */ readonly row?: Row; }; /** * The type of the editorPreparing event handler's argument. */ export type EditorPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & { /** * */ readonly parentType: string; /** * */ readonly value?: any; /** * */ readonly setValue?: any; /** * */ updateValueTimeout?: number; /** * */ readonly width?: number; /** * */ readonly disabled: boolean; /** * */ readonly rtlEnabled: boolean; /** * */ readonly editorElement: DevExpress.core.DxElement; /** * */ readonly readOnly: boolean; /** * */ editorName: string; /** * */ editorOptions: any; /** * */ readonly dataField?: string; /** * */ readonly row?: Row; }; export type ExplicitTypes = { AdaptiveDetailRowPreparingEvent: AdaptiveDetailRowPreparingEvent< TRowData, TKey >; CellClickEvent: CellClickEvent; CellDblClickEvent: CellDblClickEvent; CellHoverChangedEvent: CellHoverChangedEvent; CellPreparedEvent: CellPreparedEvent; ColumnButtonClickEvent: ColumnButtonClickEvent; ColumnButtonTemplateData: ColumnButtonTemplateData; ColumnCellTemplateData: ColumnCellTemplateData; ColumnEditCellTemplateData: ColumnEditCellTemplateData; ContentReadyEvent: ContentReadyEvent; ContextMenuPreparingEvent: ContextMenuPreparingEvent; DataErrorOccurredEvent: DataErrorOccurredEvent; DisposingEvent: DisposingEvent; EditCanceledEvent: EditCanceledEvent; EditCancelingEvent: EditCancelingEvent; Editing: Editing; EditingStartEvent: EditingStartEvent; EditorPreparedEvent: EditorPreparedEvent; EditorPreparingEvent: EditorPreparingEvent; FocusedCellChangedEvent: FocusedCellChangedEvent; FocusedCellChangingEvent: FocusedCellChangingEvent; FocusedRowChangedEvent: FocusedRowChangedEvent; FocusedRowChangingEvent: FocusedRowChangingEvent; InitializedEvent: InitializedEvent; InitNewRowEvent: InitNewRowEvent; KeyDownEvent: KeyDownEvent; NodesInitializedEvent: NodesInitializedEvent; OptionChangedEvent: OptionChangedEvent; Properties: Properties; RowClickEvent: RowClickEvent; RowCollapsedEvent: RowCollapsedEvent; RowCollapsingEvent: RowCollapsingEvent; RowDblClickEvent: RowDblClickEvent; RowDraggingAddEvent: RowDraggingAddEvent; RowDraggingChangeEvent: RowDraggingChangeEvent; RowDraggingEndEvent: RowDraggingEndEvent; RowDraggingMoveEvent: RowDraggingMoveEvent; RowDraggingRemoveEvent: RowDraggingRemoveEvent; RowDraggingReorderEvent: RowDraggingReorderEvent; RowDraggingStartEvent: RowDraggingStartEvent; RowDraggingTemplateData: DevExpress.common.grids.RowDraggingTemplateData; RowExpandedEvent: RowExpandedEvent; RowExpandingEvent: RowExpandingEvent; RowInsertedEvent: RowInsertedEvent; RowInsertingEvent: RowInsertingEvent; RowPreparedEvent: RowPreparedEvent; RowRemovedEvent: RowRemovedEvent; RowRemovingEvent: RowRemovingEvent; RowUpdatedEvent: RowUpdatedEvent; RowUpdatingEvent: RowUpdatingEvent; RowValidatingEvent: RowValidatingEvent; SavedEvent: SavedEvent; SavingEvent: SavingEvent; Scrolling: Scrolling; Selection: Selection; SelectionChangedEvent: SelectionChangedEvent; Toolbar: Toolbar; ToolbarItem: ToolbarItem; ToolbarPreparingEvent: ToolbarPreparingEvent; }; /** * The type of the focusedCellChanged event handler's argument. */ export type FocusedCellChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly columnIndex: number; /** * */ readonly rowIndex: number; /** * */ readonly row: Row; /** * */ readonly column: Column; }; /** * The type of the focusedCellChanging event handler's argument. */ export type FocusedCellChangingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxTreeList, DevExpress.events.InteractionEvent > & { /** * */ readonly cellElement: DevExpress.core.DxElement; /** * */ readonly prevColumnIndex: number; /** * */ readonly prevRowIndex: number; /** * */ newColumnIndex: number; /** * */ newRowIndex: number; /** * */ readonly rows: Array>; /** * */ readonly columns: Array>; /** * */ isHighlighted: boolean; }; /** * The type of the focusedRowChanged event handler's argument. */ export type FocusedRowChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly rowIndex: number; /** * */ readonly row: Row; }; /** * The type of the focusedRowChanging event handler's argument. */ export type FocusedRowChangingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxTreeList, DevExpress.events.InteractionEvent > & { /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly prevRowIndex: number; /** * */ newRowIndex: number; /** * */ readonly rows: Array>; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxTreeList >; /** * The type of the initNewRow event handler's argument. */ export type InitNewRowEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.NewRowInfo; /** * The type of the keyDown event handler's argument. */ export type KeyDownEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, KeyboardEvent > & DevExpress.common.grids.KeyDownInfo; /** * A TreeList node's structure. */ export type Node = { /** * Contains all child nodes. */ children?: Array>; /** * The node's data object. */ data?: TRowData; /** * Indicates whether the node has child nodes. */ hasChildren?: boolean; /** * The node's key. */ key: TKey; /** * The node's hierarchical level. */ level: number; /** * The parent node. */ parent?: Node; /** * Indicates whether the node is visualized as a row. */ visible?: boolean; }; /** * The type of the nodesInitialized event handler's argument. */ export type NodesInitializedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly root: Node; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & 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. */ type OverriddenKeys = | 'autoExpandAll' | 'columns' | 'customizeColumns' | 'dataStructure' | 'editing' | 'expandedRowKeys' | 'expandNodesOnFiltering' | 'filterMode' | 'hasItemsExpr' | 'itemsExpr' | 'keyExpr' | 'onCellClick' | 'onCellDblClick' | 'onCellHoverChanged' | 'onCellPrepared' | 'onContextMenuPreparing' | 'onEditingStart' | 'onEditorPrepared' | 'onEditorPreparing' | 'onFocusedCellChanged' | 'onFocusedCellChanging' | 'onFocusedRowChanged' | 'onFocusedRowChanging' | 'onNodesInitialized' | 'onRowClick' | 'onRowDblClick' | 'onRowPrepared' | 'paging' | 'parentIdExpr' | 'remoteOperations' | 'rootValue' | 'scrolling' | 'selection' | 'toolbar'; /** * An object that configures paging. */ export type Paging = DevExpress.common.grids.PagingBase & { /** * Specifies whether paging is enabled. */ enabled?: boolean; }; export type Properties = dxTreeListOptions< TRowData, TKey >; /** * A grid row. */ export type Row = { /** * Indicates whether the row is in the editing state. */ readonly isEditing?: boolean; /** * Indicates whether the row is expanded or collapsed. Available if rowType is 'data'. */ readonly isExpanded?: boolean; /** * Indicates that the row is added, but not yet saved. Available if rowType is 'data'. */ readonly isNewRow?: boolean; /** * Indicates whether the row is selected. Available if rowType is 'data' or 'detail'. */ readonly isSelected?: boolean; /** * The row's key. Available if rowType is 'data', 'detail' or 'detailAdaptive'. */ readonly key: TKey; /** * The row's hierarchical level. Available if rowType is 'data' or 'detail'. */ readonly level: number; /** * The row's node. Available if rowType is 'data' or 'detail'. */ readonly node: Node; /** * The row's visible index. This index is zero-based and available if rowType is 'data', 'detail' or 'detailAdaptive'. */ readonly rowIndex: number; /** * The row's type. */ readonly rowType: string; /** * Values displayed in the row's cells. */ readonly values: Array; /** * A data object that the row visualizes. */ readonly data: TRowData; }; /** * The type of the rowClick event handler's argument. */ export type RowClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly handled: boolean; /** * */ readonly node: Node; /** * */ readonly level: number; }; /** * The type of the rowCollapsed event handler's argument. */ export type RowCollapsedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowCollapsing event handler's argument. */ export type RowCollapsingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowDblClick event handler's argument. */ export type RowDblClickEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxTreeList, PointerEvent | MouseEvent > & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly rowElement: DevExpress.core.DxElement; }; export type RowDraggingAddEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingChangeEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingEndEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingMoveEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragDropInfo; export type RowDraggingRemoveEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo; export type RowDraggingReorderEvent< TRowData = any, TKey = any > = DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.RowDraggingEventInfo & DevExpress.common.grids.DragReorderInfo; export type RowDraggingStartEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.ReducedNativeEventInfo> & DevExpress.common.grids.DragStartEventInfo; /** * The type of the rowExpanded event handler's argument. */ export type RowExpandedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowExpanding event handler's argument. */ export type RowExpandingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowKeyInfo; /** * The type of the rowInserted event handler's argument. */ export type RowInsertedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowInsertedInfo; /** * The type of the rowInserting event handler's argument. */ export type RowInsertingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowInsertingInfo; /** * The type of the rowPrepared event handler's argument. */ export type RowPreparedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & { /** * */ readonly data: TRowData; /** * */ readonly key: TKey; /** * */ readonly values: Array; /** * */ readonly columns: Array>; /** * */ readonly rowIndex: number; /** * */ readonly rowType: string; /** * */ readonly isSelected?: boolean; /** * */ readonly isExpanded?: boolean; /** * */ readonly isNewRow?: boolean; /** * */ readonly rowElement: DevExpress.core.DxElement; /** * */ readonly node: Node; /** * */ readonly level: number; }; /** * The type of the rowRemoved event handler's argument. */ export type RowRemovedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowRemovedInfo; /** * The type of the rowRemoving event handler's argument. */ export type RowRemovingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowRemovingInfo; /** * The type of the rowUpdated event handler's argument. */ export type RowUpdatedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowUpdatedInfo; /** * The type of the rowUpdating event handler's argument. */ export type RowUpdatingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowUpdatingInfo; /** * The type of the rowValidating event handler's argument. */ export type RowValidatingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.RowValidatingInfo; /** * The type of the saved event handler's argument. */ export type SavedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.DataChangeInfo; /** * The type of the saving event handler's argument. */ export type SavingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.SavingInfo; export type Scrollable = Omit< dxScrollable, | '_templateManager' | '_cancelOptionChange' | '_getTemplate' | '_invalidate' | '_refresh' | '_notifyOptionChanged' | '_createElement' >; /** * Configures scrolling. */ export interface Scrolling extends DevExpress.common.grids.ScrollingBase { /** * Specifies the scrolling mode. */ mode?: DevExpress.common.ScrollMode; } /** * Configures runtime selection. */ export interface Selection extends DevExpress.common.grids.SelectionBase { /** * Specifies whether selection is recursive. */ recursive?: boolean; } /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.SelectionChangedInfo; /** * The type of the toolbarPreparing event handler's argument. */ export type ToolbarPreparingEvent< TRowData = any, TKey = any > = DevExpress.common.core.events.EventInfo> & DevExpress.common.grids.ToolbarPreparingInfo; export type TreeListCommandColumnType = 'adaptive' | 'buttons' | 'drag'; export type TreeListFilterMode = | 'fullBranch' | 'withAncestors' | 'matchOnly'; export type TreeListPredefinedColumnButton = | 'add' | 'cancel' | 'delete' | 'edit' | 'save' | 'undelete'; export type TreeListPredefinedToolbarItem = | 'addRowButton' | 'applyFilterButton' | 'columnChooserButton' | 'revertButton' | 'saveButton' | 'searchPanel'; } /** * @deprecated Use the DevExpress.ui.dxTreeList.Column type instead * @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 dxTreeListColumn extends DevExpress.common.grids.ColumnBase { /** * Allows you to customize buttons in the edit column or create a custom command column. Applies only if the column's type is 'buttons'. */ buttons?: Array< | DevExpress.ui.dxTreeList.TreeListPredefinedColumnButton | DevExpress.ui.dxTreeList.ColumnButton >; /** * Specifies a custom template for data cells. */ cellTemplate?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxTreeList.ColumnCellTemplateData< TRowData, TKey > ) => any); /** * Configures columns. */ columns?: | Array | string> | undefined; /** * Specifies a custom template for data cells in an editing state. */ editCellTemplate?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxTreeList.ColumnEditCellTemplateData< TRowData, TKey > ) => any); /** * Specifies a custom template for column headers. */ headerCellTemplate?: | template | (( columnHeader: DevExpress.core.DxElement, headerInfo: DevExpress.ui.dxTreeList.ColumnHeaderCellTemplateData< TRowData, TKey > ) => any); /** * Specifies the command column that this object customizes. */ type?: DevExpress.ui.dxTreeList.TreeListCommandColumnType; } /** * @deprecated Use the TreeList's ColumnButton type instead * @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 dxTreeListColumnButton extends DevExpress.common.grids.ColumnButtonBase { /** * The name used to identify a built-in button. */ name?: DevExpress.ui.dxTreeList.TreeListPredefinedColumnButton | string; /** * A function that is executed when the button is clicked or tapped. */ onClick?: ( e: DevExpress.ui.dxTreeList.ColumnButtonClickEvent ) => void; /** * Specifies a custom button template. */ template?: | template | (( cellElement: DevExpress.core.DxElement, cellInfo: DevExpress.ui.dxTreeList.ColumnButtonTemplateData< TRowData, TKey > ) => string | DevExpress.core.UserDefinedElement); /** * Specifies the button's visibility. */ visible?: | boolean | ((options: { readonly component: dxTreeList; readonly row?: DevExpress.ui.dxTreeList.Row; readonly column: DevExpress.ui.dxTreeList.Column; }) => boolean); /** * Specifies whether the button is disabled. */ disabled?: | boolean | ((options: { readonly component: dxTreeList; readonly row?: DevExpress.ui.dxTreeList.Row; readonly column: DevExpress.ui.dxTreeList.Column; }) => boolean); } /** * @deprecated Use DevExpress.ui.dxTreeList.Node instead * @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 dxTreeListNode< TRowData = any, TKey = any > = DevExpress.ui.dxTreeList.Node; /** * * @deprecated */ export type dxTreeListOptions = Omit< DevExpress.common.grids.GridBaseOptions< dxTreeList, TRowData, TKey >, DevExpress.ui.dxTreeList.OverriddenKeys > & { /** * Specifies whether all rows are expanded. */ autoExpandAll?: boolean; /** * Configures columns. */ columns?: | Array | string> | undefined; /** * Customizes columns after they are created. */ customizeColumns?: ( columns: Array> ) => void; /** * Notifies the UI component of the used data structure. */ dataStructure?: DevExpress.common.DataStructure; /** * Configures editing. */ editing?: DevExpress.ui.dxTreeList.Editing; /** * Specifies whether nodes appear expanded or collapsed after filtering is applied. */ expandNodesOnFiltering?: boolean; /** * Specifies expanded rows with keys. */ expandedRowKeys?: Array; /** * Specifies whether filter and search results should include matching rows only, matching rows with ancestors, or matching rows with ancestors and descendants (full branch). */ filterMode?: DevExpress.ui.dxTreeList.TreeListFilterMode; /** * Specifies which data field defines whether the node has children. */ hasItemsExpr?: string | Function; /** * Specifies which data field contains nested items. Set this property when your data has a hierarchical structure. */ itemsExpr?: string | Function; /** * Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. */ keyExpr?: string | Function; /** * A function that is executed when a cell is clicked or tapped. Executed before onRowClick. */ onCellClick?: ( e: DevExpress.ui.dxTreeList.CellClickEvent ) => void; /** * A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick. */ onCellDblClick?: ( e: DevExpress.ui.dxTreeList.CellDblClickEvent ) => void; /** * A function that is executed after the pointer enters or leaves a cell. */ onCellHoverChanged?: ( e: DevExpress.ui.dxTreeList.CellHoverChangedEvent ) => void; /** * A function that is executed after a grid cell is created. */ onCellPrepared?: ( e: DevExpress.ui.dxTreeList.CellPreparedEvent ) => void; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing?: ( e: DevExpress.ui.dxTreeList.ContextMenuPreparingEvent ) => void; /** * A function that is executed before a cell or row switches to the editing state. */ onEditingStart?: ( e: DevExpress.ui.dxTreeList.EditingStartEvent ) => void; /** * A function that is executed after an editor is created. Not executed for cells with an editCellTemplate. */ onEditorPrepared?: ( options: DevExpress.ui.dxTreeList.EditorPreparedEvent ) => void; /** * A function used to customize cell editors. Not executed for cells with an editCellTemplate. */ onEditorPreparing?: ( e: DevExpress.ui.dxTreeList.EditorPreparingEvent ) => void; /** * A function that is executed after the focused cell changes. Applies only to cells in data rows. */ onFocusedCellChanged?: ( e: DevExpress.ui.dxTreeList.FocusedCellChangedEvent ) => void; /** * A function that is executed before the focused cell changes. Applies only to cells in data rows. */ onFocusedCellChanging?: ( e: DevExpress.ui.dxTreeList.FocusedCellChangingEvent ) => void; /** * A function that executed when the focused row changes. Applies only to data rows. focusedRowEnabled should be true. */ onFocusedRowChanged?: ( e: DevExpress.ui.dxTreeList.FocusedRowChangedEvent ) => void; /** * A function that is executed before the focused row changes. Applies only to data rows. focusedRowEnabled should be true. */ onFocusedRowChanging?: ( e: DevExpress.ui.dxTreeList.FocusedRowChangingEvent ) => void; /** * A function that is executed after the loaded nodes are initialized. */ onNodesInitialized?: ( e: DevExpress.ui.dxTreeList.NodesInitializedEvent ) => void; /** * A function that is executed when a grid row is clicked or tapped. */ onRowClick?: ( e: DevExpress.ui.dxTreeList.RowClickEvent ) => void; /** * A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick. */ onRowDblClick?: ( e: DevExpress.ui.dxTreeList.RowDblClickEvent ) => void; /** * A function that is executed after a row is created. */ onRowPrepared?: ( e: DevExpress.ui.dxTreeList.RowPreparedEvent ) => void; /** * Configures paging. */ paging?: DevExpress.ui.dxTreeList.Paging; /** * Specifies which data field provides parent keys. */ parentIdExpr?: string | Function; /** * Notifies the TreeList of the server's data processing operations. Applies only if data has a plain structure. */ remoteOperations?: | { /** * Specifies whether filtering should be performed on the server. */ filtering?: boolean; /** * Specifies whether grouping should be performed on the server. */ grouping?: boolean; /** * Specifies whether sorting should be performed on the server. */ sorting?: boolean; } | DevExpress.common.Mode; /** * Specifies the root key. Applies if dataStructure is 'plain'. */ rootValue?: TKey; /** * Configures scrolling. */ scrolling?: DevExpress.ui.dxTreeList.Scrolling; /** * Configures runtime selection. */ selection?: DevExpress.ui.dxTreeList.Selection; /** * Configures the toolbar. */ toolbar?: DevExpress.ui.dxTreeList.Toolbar | undefined; }; /** * @deprecated Use DevExpress.ui.dxTreeList.Row instead * @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 dxTreeListRowObject< TRowData = any, TKey = any > = DevExpress.ui.dxTreeList.Row; /** * The TreeView UI component is a tree-like representation of textual data. */ export class dxTreeView extends HierarchicalCollectionWidget< dxTreeViewOptions, dxTreeViewItem, TKey > { /** * Collapses all items. */ collapseAll(): void; /** * Collapses an item with a specific key. */ collapseItem( itemData: DevExpress.ui.dxTreeView.Item ): DevExpress.core.utils.DxPromise; /** * Collapses an item found using its DOM node. */ collapseItem(itemElement: Element): DevExpress.core.utils.DxPromise; /** * Collapses an item with a specific key. */ collapseItem(key: TKey): DevExpress.core.utils.DxPromise; /** * Expands all items. If you load items on demand, this method expands only the loaded items. */ expandAll(): void; /** * Expands an item found using its data object. */ expandItem( itemData: DevExpress.ui.dxTreeView.Item ): DevExpress.core.utils.DxPromise; /** * Expands an item found using its DOM node. */ expandItem(itemElement: Element): DevExpress.core.utils.DxPromise; /** * Expands an item with a specific key. */ expandItem(key: TKey): DevExpress.core.utils.DxPromise; /** * Gets all nodes. */ getNodes(): Array>; /** * Gets selected nodes. */ getSelectedNodes(): Array>; /** * Gets the keys of selected nodes. */ getSelectedNodeKeys(): Array; /** * Selects all nodes. */ selectAll(): void; /** * Gets the instance of the UI component's scrollable part. */ getScrollable(): DevExpress.ui.dxTreeView.Scrollable; /** * Selects a node found using its data object. */ selectItem(itemData: DevExpress.ui.dxTreeView.Item): boolean; /** * Selects a TreeView node found using its DOM node. */ selectItem(itemElement: Element): boolean; /** * Selects a node with a specific key. */ selectItem(key: TKey): boolean; /** * Cancels the selection of all nodes. */ unselectAll(): void; /** * Cancels the selection of a node found using its data object. */ unselectItem(itemData: DevExpress.ui.dxTreeView.Item): boolean; /** * Cancels the selection of a TreeView node found using its DOM node. */ unselectItem(itemElement: Element): boolean; /** * Cancels the selection of a node with a specific key. */ unselectItem(key: TKey): boolean; /** * Updates the tree view scrollbars according to the current size of the UI component content. */ updateDimensions(): DevExpress.core.utils.DxPromise; /** * Scrolls the content to an item found using its data. */ scrollToItem( itemData: DevExpress.ui.dxTreeView.Item ): DevExpress.core.utils.DxPromise; /** * Scrolls the content to an item found using its DOM node. */ scrollToItem(itemElement: Element): DevExpress.core.utils.DxPromise; /** * Scrolls the content to an item found using its key. */ scrollToItem(key: TKey): DevExpress.core.utils.DxPromise; } module dxTreeView { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = DevExpress.common.core.events.EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo>; export type ExplicitTypes = { Properties: Properties; Node: Node; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemCollapsedEvent: ItemCollapsedEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemExpandedEvent: ItemExpandedEvent; ItemHoldEvent: ItemHoldEvent; ItemRenderedEvent: ItemRenderedEvent; ItemSelectionChangedEvent: ItemSelectionChangedEvent; OptionChangedEvent: OptionChangedEvent; SelectAllValueChangedEvent: SelectAllValueChangedEvent; SelectionChangedEvent: SelectionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeView, KeyboardEvent | MouseEvent | PointerEvent > & ItemInfo; /** * The type of the itemCollapsed event handler's argument. */ export type ItemCollapsedEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeView, MouseEvent | PointerEvent > & ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeView, DevExpress.events.PointerInteractionEvent > & ItemInfo; /** * The type of the itemExpanded event handler's argument. */ export type ItemExpandedEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeView, MouseEvent | PointerEvent > & ItemInfo; /** * The type of the itemHold event handler's argument. */ export type ItemHoldEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeView, DevExpress.events.PointerInteractionEvent > & ItemInfo; /** * * @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 ItemInfo { /** * */ readonly itemData?: Item; /** * */ readonly itemElement?: DevExpress.core.DxElement; /** * */ readonly itemIndex?: number; /** * */ readonly node?: Node; } /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent = DevExpress.common.core.events.EventInfo> & ItemInfo; /** * The type of the itemSelectionChanged event handler's argument. */ export type ItemSelectionChangedEvent = DevExpress.common.core.events.EventInfo> & ItemInfo; /** * A TreeView node. */ export type Node = dxTreeViewNode; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo> & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxTreeViewOptions; export type Scrollable = Omit< dxScrollable, | '_templateManager' | '_cancelOptionChange' | '_getTemplate' | '_invalidate' | '_refresh' | '_notifyOptionChanged' | '_createElement' >; /** * The type of the selectAllValueChanged event handler's argument. */ export type SelectAllValueChangedEvent = DevExpress.common.core.events.EventInfo> & { /** * */ readonly value?: boolean | undefined; }; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo>; export type TreeViewCheckBoxMode = 'none' | 'normal' | 'selectAll'; export type TreeViewExpandEvent = 'dblclick' | 'click'; } /** * @deprecated Use Item instead * @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 dxTreeViewItem extends CollectionWidgetItem { /** * Specifies whether or not the tree view item is displayed expanded. */ expanded?: boolean; /** * Specifies whether or not the tree view item has children. */ hasItems?: boolean | undefined; /** * Specifies the tree view item's icon. */ icon?: string; /** * Specifies nested tree view items. */ items?: Array; /** * Holds the unique key of an item. */ id?: number | string | undefined; /** * Holds the key of the parent item. */ parentId?: number | string | undefined; /** * Specifies whether the TreeView item should be displayed as selected. */ selected?: boolean; [key: string]: any; } /** * A TreeView node. * @deprecated * @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 dxTreeViewNode { /** * Contains all the child nodes of the current node. */ children?: Array>; /** * Equals to true if the node is disabled; otherwise false. */ disabled?: boolean; /** * Equals true if the node is expanded; false if collapsed. */ expanded?: boolean; /** * Contains the data source object corresponding to the node. */ itemData?: DevExpress.ui.dxTreeView.Item; /** * Contains the key value of the node. */ key?: TKey; /** * Refers to the parent node of the current node. */ parent?: dxTreeViewNode; /** * Equals to true if the node is selected; false if not. */ selected?: boolean; /** * Contains the text displayed by the node. */ text?: string; } /** * * @deprecated */ export interface dxTreeViewOptions extends Omit< HierarchicalCollectionWidgetOptions< dxTreeView, dxTreeViewItem, TKey >, 'dataSource' >, SearchBoxMixinOptions { /** * Specifies whether or not to animate item collapsing and expanding. */ animationEnabled?: boolean; /** * Allows you to load nodes on demand. */ createChildren?: ( parentNode: DevExpress.ui.dxTreeView.Node ) => PromiseLike | Array; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike< DevExpress.ui.dxTreeView.Item, TKey > | null; /** * Notifies the UI component of the data structure in use. */ dataStructure?: DevExpress.common.DataStructure; /** * Specifies whether or not a user can expand all tree view items by the '*' hot key. */ expandAllEnabled?: boolean; /** * Specifies the event on which to expand/collapse a node. */ expandEvent?: DevExpress.ui.dxTreeView.TreeViewExpandEvent; /** * Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. */ expandNodesRecursive?: boolean; /** * Specifies which data source field specifies whether an item is expanded. */ expandedExpr?: string | Function; /** * Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. */ hasItemsExpr?: string | Function; /** * An array of items displayed by the UI component. */ items?: Array; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick?: (e: DevExpress.ui.dxTreeView.ItemClickEvent) => void; /** * A function that is executed when a tree view item is collapsed. */ onItemCollapsed?: ( e: DevExpress.ui.dxTreeView.ItemCollapsedEvent ) => void; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu?: ( e: DevExpress.ui.dxTreeView.ItemContextMenuEvent ) => void; /** * A function that is executed when a tree view item is expanded. */ onItemExpanded?: ( e: DevExpress.ui.dxTreeView.ItemExpandedEvent ) => void; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold?: (e: DevExpress.ui.dxTreeView.ItemHoldEvent) => void; /** * A function that is executed after a collection item is rendered. */ onItemRendered?: ( e: DevExpress.ui.dxTreeView.ItemRenderedEvent ) => void; /** * A function that is executed when a single TreeView item is selected or selection is canceled. */ onItemSelectionChanged?: ( e: DevExpress.ui.dxTreeView.ItemSelectionChangedEvent ) => void; /** * A function that is executed when the 'Select All' check box value is changed. Applies only if showCheckBoxesMode is 'selectAll' and selectionMode is 'multiple'. */ onSelectAllValueChanged?: ( e: DevExpress.ui.dxTreeView.SelectAllValueChangedEvent ) => void; /** * A function that is executed when a TreeView item is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.ui.dxTreeView.SelectionChangedEvent ) => void; /** * Specifies the name of the data source item field for holding the parent key of the corresponding node. */ parentIdExpr?: string | Function; /** * Specifies the root key. */ rootValue?: any; /** * A string value specifying available scrolling directions. */ scrollDirection?: DevExpress.common.ScrollDirection; /** * Specifies the text displayed at the 'Select All' check box. */ selectAllText?: string; /** * Specifies whether an item is selected if a user clicks it. */ selectByClick?: boolean; /** * Specifies whether all child nodes should be selected when their parent node is selected. Applies only if the selectionMode is 'multiple'. */ selectNodesRecursive?: boolean; /** * Specifies item selection mode. Applies only if selection is enabled. */ selectionMode?: DevExpress.common.SingleOrMultiple; /** * Specifies the checkbox display mode. */ showCheckBoxesMode?: DevExpress.ui.dxTreeView.TreeViewCheckBoxMode; /** * Specifies a custom collapse icon. */ collapseIcon?: string | null; /** * Specifies a custom expand icon. */ expandIcon?: string | null; /** * Enables the virtual mode in which nodes are loaded on demand. Use it to enhance the performance on large datasets. */ virtualModeEnabled?: boolean; /** * Specifies whether or not the UI component uses native scrolling. */ useNativeScrolling?: boolean; } /** * The ValidationGroup is a UI component that allows you to validate several editors simultaneously. */ export class dxValidationGroup extends DOMComponent { /** * Resets the value and validation result of the editors that are included to the current validation group. */ reset(): void; /** * Validates rules of the validators that belong to the current validation group. */ validate(): DevExpress.ui.dxValidationGroup.ValidationResult; } module dxValidationGroup { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxValidationGroupOptions; export type ValidationResult = dxValidationGroupResult; } /** * * @deprecated * @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 dxValidationGroupOptions extends DOMComponentOptions {} /** * A group validation result. * @deprecated * @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 dxValidationGroupResult { /** * An array of the validation rules that failed. */ brokenRules?: Array< | DevExpress.common.RequiredRule | DevExpress.common.NumericRule | DevExpress.common.RangeRule | DevExpress.common.StringLengthRule | DevExpress.common.CustomRule | DevExpress.common.CompareRule | DevExpress.common.PatternRule | DevExpress.common.EmailRule | DevExpress.common.AsyncRule >; /** * A promise that is fulfilled when all async rules are validated. */ complete?: DevExpress.core.utils.DxPromise; /** * Indicates whether all the rules checked for the group are satisfied. */ isValid?: boolean; /** * Indicates the validation status. */ status?: DevExpress.common.ValidationStatus; /** * Validator UI components included in the validated group. */ validators?: Array; } /** * @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 dxValidationMessage extends dxOverlay {} module dxValidationMessage { export type Properties = dxValidationMessageOptions; } /** * @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 dxValidationMessageOptions extends dxOverlayOptions { mode?: string; validationErrors?: Array | null; positionSide?: string; boundary?: String | DevExpress.core.UserDefinedElement; offset?: object; } /** * A UI component for displaying the result of checking validation rules for editors. */ export class dxValidationSummary< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends CollectionWidget< dxValidationSummaryOptions, TItem, TKey > { /** * Resubscribes the ValidationSummary to a target ValidationGroup. */ refreshValidationGroup(): void; } module dxValidationSummary { /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo< dxValidationSummary >; /** * The type of the disposing event handler's argument. */ export type DisposingEvent< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo< dxValidationSummary >; export type ExplicitTypes< TItem extends DevExpress.ui.CollectionWidget.ItemLike, TKey > = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; OptionChangedEvent: OptionChangedEvent; }; /** * The type of the initialized event handler's argument. */ export type InitializedEvent< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = DevExpress.common.core.events.InitializedEventInfo< dxValidationSummary >; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = DevExpress.common.core.events.NativeEventInfo< dxValidationSummary, MouseEvent | PointerEvent > & DevExpress.common.core.events.ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = DevExpress.common.core.events.EventInfo< dxValidationSummary > & DevExpress.common.core.events.ChangedOptionInfo; export type Properties< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > = dxValidationSummaryOptions; } /** * * @deprecated */ export interface dxValidationSummaryOptions< TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends CollectionWidgetOptions< dxValidationSummary, TItem, TKey > { /** * Specifies the validation group for which summary should be generated. */ validationGroup?: string; } /** * A UI component that is used to validate the associated DevExtreme editors against the defined validation rules. */ export class dxValidator extends DOMComponent { /** * Sets focus to the editor associated with the current Validator object. */ focus(): void; /** * Resets the value and validation result of the editor associated with the current Validator object. */ reset(): void; /** * Validates the value of the editor that is controlled by the current Validator object against the list of the specified validation rules. */ validate(): DevExpress.ui.dxValidator.ValidationResult; } module dxValidator { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxValidatorOptions; /** * The type of the validated event handler's argument. */ export type ValidatedEvent = { /** * The value of the name property. */ name?: string; /** * Indicates whether the value satisfies all rules. */ isValid?: boolean; /** * The validated value. */ value?: any; /** * An array of validation rules specified for the current dxValidator object. */ validationRules?: Array; /** * The object that represents the first broken rule on the list of specified validation rules. */ brokenRule?: DevExpress.common.ValidationRule; /** * An array of validationRules that failed to pass the check. */ brokenRules?: Array; /** * Indicates the validation status. */ status?: DevExpress.common.ValidationStatus; }; export type ValidationResult = dxValidatorResult; } /** * * @deprecated * @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 dxValidatorOptions extends DOMComponentOptions { /** * An object that specifies what and when to validate, and how to apply the validation result. */ adapter?: { /** * A function that the Validator UI component calls after validating a specified value. */ applyValidationResults?: Function; /** * A function that returns a Boolean value specifying whether or not to bypass validation. */ bypass?: Function; /** * A function that sets focus to a validated editor when the corresponding ValidationSummary item is focused. */ focus?: Function; /** * A function that returns the value to be validated. */ getValue?: Function; /** * A function that resets the validated values. */ reset?: Function; /** * Callbacks to be executed on the value validation. */ validationRequestsCallbacks?: Array; }; /** * Specifies the editor name to be used in the validation default messages. */ name?: string; /** * A function that is executed after a value is validated. */ onValidated?: ( validatedInfo: DevExpress.ui.dxValidator.ValidatedEvent ) => void; /** * Specifies the validation group the editor will be related to. */ validationGroup?: string; /** * An array of validation rules to be checked for the editor with which the dxValidator object is associated. */ validationRules?: Array; } /** * A validation result. * @deprecated * @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 dxValidatorResult { /** * A rule that failed to pass the check. Contains the first item from the brokenRules array. */ brokenRule?: DevExpress.common.ValidationRule; /** * An array of the validationRules that failed to pass the check. */ brokenRules?: Array; /** * A promise that is fulfilled when all async rules are validated. */ complete?: DevExpress.core.utils.DxPromise; /** * Indicates whether all the checked rules are satisfied. */ isValid?: boolean; /** * An array of async rules whose promises are not fulfilled or rejected. Contains items only when the status is 'pending'. */ pendingRules?: Array; /** * Indicates the validation status. */ status?: DevExpress.common.ValidationStatus; /** * Validation rules specified for the Validator. */ validationRules?: Array; /** * The value being validated. */ value?: any; } /** * A base class for editors. * @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 Editor< TProperties extends DevExpress.ui.Editor.EditorOptionsWithValue = DevExpress.ui.Editor.Properties > extends Widget { /** * Resets the value property to the default value. */ clear(): void; /** * Resets the value property to the value passed as an argument. */ reset(value?: TProperties['value']): void; } module Editor { /** * @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 EditorInstance extends Editor {} /** * * @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 EditorOptionsWithValue { value?: 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. */ type Properties = EditorOptions; /** * * @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 ValueChangedInfo { /** * */ readonly previousValue?: any; /** * */ readonly value?: 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 interface EditorOptions extends WidgetOptions { /** * Specifies or indicates whether the editor's value is valid. */ isValid?: boolean; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: ( e: DevExpress.common.core.events.NativeEventInfo & DevExpress.ui.Editor.ValueChangedInfo ) => void; /** * Specifies whether the editor is read-only. */ readOnly?: boolean; /** * Information on the broken validation rule. Contains the first item from the validationErrors array. */ validationError?: any; /** * An array of validation errors. */ validationErrors?: Array; /** * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. */ validationMessageMode?: DevExpress.common.ValidationMessageMode; /** * Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. */ validationMessagePosition?: DevExpress.common.Position; /** * Indicates or specifies the current validation status. */ validationStatus?: DevExpress.common.ValidationStatus; /** * Specifies the UI component's value. */ value?: any; /** * */ stylingMode?: DevExpress.common.EditorStyle; /** * Specifies whether the component's current value differs from the initial value. */ readonly isDirty?: boolean; } /** * The FilterBuilder's field structure. */ export type Field = dxFilterBuilderField; /** * Hides all the Toast components in the application. */ export function hideToasts(): void; /** * The base class for UI components containing an item collection. * @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 HierarchicalCollectionWidget< TProperties extends HierarchicalCollectionWidgetOptions, TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends CollectionWidget {} /** * * @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 HierarchicalCollectionWidgetOptions< TComponent extends HierarchicalCollectionWidget, TItem extends DevExpress.ui.CollectionWidget.ItemLike = any, TKey = any > extends CollectionWidgetOptions { /** * Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled. */ disabledExpr?: string | Function; /** * Specifies the data field whose values should be displayed. */ displayExpr?: string | ((item: TItem) => string); /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * Specifies which data field contains nested items. */ itemsExpr?: string | Function; /** * Specifies which data field provides keys for TreeView items. */ keyExpr?: string | Function; /** * Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected. */ selectedExpr?: string | Function; } /** * The selected Map location. */ export interface MapLocation { /** * The latitude location of the UI component. */ lat: number; /** * The longitude location of the UI component. */ lng: number; } /** * Creates a toast message. */ export function notify( message: string, type?: string, displayTime?: number ): void; /** * Creates a toast message. */ export function notify( options: any, type?: string, displayTime?: number ): void; /** * Creates a stackable toast message. */ export function notify(message: string, stack?: Stack): void; /** * Creates a stackable toast message. */ export function notify(options: any, stack?: Stack): void; /** * Repaints the Floating Action Button. */ export function repaintFloatingActionButton(): 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 SearchBoxMixin { constructor(options?: SearchBoxMixinOptions); } /** * * @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 SearchBoxMixinOptions { /** * Configures the search panel. */ searchEditorOptions?: DevExpress.ui.dxTextBox.Properties; /** * Specifies whether the search panel is visible. */ searchEnabled?: boolean; /** * Specifies a data object's field name or an expression whose value is compared to the search string. */ searchExpr?: string | Function | Array; /** * Specifies a comparison operation used to search UI component items. */ searchMode?: DevExpress.common.SearchMode; /** * Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. */ searchTimeout?: number | undefined; /** * Specifies the current search string. */ searchValue?: string; } interface Stack { /** * */ position?: | 'top left' | 'top right' | 'bottom left' | 'bottom right' | 'top center' | 'bottom center' | 'left center' | 'right center' | 'center' | { /** * */ top?: number; /** * */ left?: number; /** * */ bottom?: number; /** * */ right?: number; }; /** * */ direction?: | 'down-push' | 'up-push' | 'left-push' | 'right-push' | 'down-stack' | 'up-stack' | 'left-stack' | 'right-stack'; } /** * * @deprecated */ export type Template = template; /** * An object that serves as a namespace for the methods that work with DevExtreme CSS Themes. */ export class themes { /** * Gets the current theme's name. */ static current(): string; /** * Sets a theme with a specific name. */ static current(themeName: string): void; /** * Specifies a function to be executed each time a theme is switched. */ static ready(callback: Function): void; /** * Specifies a function to be executed after a theme is loaded. */ static initialized(callback: Function): void; } /** * The base class for 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 Widget extends DOMComponent { /** * Sets focus on the UI component. */ focus(): void; /** * Registers a handler to be executed when a user presses a specific key. */ registerKeyHandler(key: string, handler: Function): void; /** * Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. */ repaint(): void; } module Widget { /** * * @deprecated * @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 format = DevExpress.common.core.localization.Format; } /** * * @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 WidgetOptions extends DOMComponentOptions { /** * Specifies the shortcut key that sets focus on the UI component. */ accessKey?: string | undefined; /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ activeStateEnabled?: boolean; /** * Specifies whether the UI component responds to user interaction. */ disabled?: boolean; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled?: boolean; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint?: string | undefined; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled?: boolean; /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ onContentReady?: ( e: DevExpress.common.core.events.EventInfo ) => void; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex?: number; /** * Specifies whether the UI component is visible. */ visible?: boolean; } } declare module DevExpress.ui.dialog { /** * Displays an alert dialog with a message and OK button. */ export function alert( messageHtml: string, title: string ): DevExpress.core.utils.DxPromise; /** * Creates a confirmation dialog with a message and Yes and No buttons. */ export function confirm( messageHtml: string, title: string ): DevExpress.core.utils.DxPromise; /** * Creates a dialog with custom buttons. */ export function custom(options: CustomDialogOptions): any; } declare module DevExpress.ui.dxAccordion { export type Item = dxAccordionItem; } declare module DevExpress.ui.dxActionSheet { export type Item = dxActionSheetItem; } declare module DevExpress.ui.dxBox { export type Item = dxBoxItem; } declare module DevExpress.ui.dxButtonGroup { export type Item = dxButtonGroupItem; } declare module DevExpress.ui.dxCardView { /** * Configures the card cover. */ export type CardCover = { /** * Specifies which data field to use as the `src` argument of the cover image. */ imageExpr: string | ((data: TCardData) => string); /** * Specifies which data field to use as the `alt` argument of the cover image. */ altExpr: string | ((data: TCardData) => string); /** * Specifies the maximum height for the card cover. */ maxHeight?: number; /** * Specifies the aspect ratio of the image container. */ aspectRatio?: string; /** * Specifies a custom template for the card cover. */ template?: | template | (( data: CardTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); }; /** * Configures the card header. */ export type CardHeader = { /** * Specifies whether to display the card header. */ visible?: boolean; /** * Configures card header items. */ items?: Array; /** * Specifies a custom template for the card header. */ template?: | template | (( data: CardTemplateData ) => string | DevExpress.core.UserDefinedElement); }; /** * Configures card header items. */ export type CardHeaderItem = dxToolbarItem & { /** * A name used to identify the card header item. */ name?: CardHeaderPredefinedItem | string; /** * Specifies the item's location in the card header. */ location?: DevExpress.common.ToolbarItemLocation; }; /** * The information about the card. */ export type CardInfo = { /** * The card's index. */ index: number; /** * Specifies columns associated with the card. */ columns: Column[]; /** * The card fields. */ fields: FieldInfo[]; /** * The card's key. */ key: TKey; /** * The card's data. */ data: TCardData; /** * Specifies whether the card is selected. */ isSelected?: boolean; /** * Values of the card as they exist in the data source. */ values: any[]; }; /** * Configures the column. */ export type Column = ColumnProperties< TCardData, TKey > & { defaultCalculateFilterExpression: NonNullable< ColumnProperties['calculateFilterExpression'] >; defaultSetFieldValue: NonNullable; defaultCalculateFieldValue: NonNullable< ColumnProperties['calculateFieldValue'] >; }; /** * Configures column properties. */ export type ColumnProperties = { /** * Aligns the content of the entire column. */ alignment?: DevExpress.common.HorizontalAlignment | undefined; /** * Specifies whether a user can edit cards in this column at runtime. Inherits the value of the editing.allowUpdating property. */ allowEditing?: boolean; /** * Specifies whether data can be filtered by this column. */ allowFiltering?: boolean; /** * Specifies whether data of this column can be filtered in header filter. Inherits the value of the allowFiltering property. */ allowHeaderFiltering?: boolean; /** * Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is `true`. */ allowHiding?: boolean; /** * Specifies whether users can reorder this column. Overrides the allowColumnReordering property value. */ allowReordering?: boolean; /** * Specifies whether this column can be searched. Applies only if searchPanel.visible is `true`. Inherits the value of the allowFiltering property. */ allowSearch?: boolean; /** * Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from 'none'. */ allowSorting?: boolean; /** * Calculates custom field values. */ calculateFieldValue?: (this: Column, cardData: TCardData) => any; /** * Calculates custom display values for column fields. Requires specifying the dataField or calculateFieldValue property. */ calculateDisplayValue?: (this: Column, cardData: TCardData) => any; /** * Specifies the column's custom rules to filter data. */ calculateFilterExpression?: ( this: Column, filterValue: any, selectedFilterOperation: string | null, target: string ) => string | Array | Function; /** * Calculates custom values used to sort this column. */ calculateSortValue?: string | ((this: Column, cardData: TCardData) => any); /** * Specifies a caption for the column. */ caption?: string | undefined; /** * Customizes text displayed in field values. */ customizeText?: ( this: Column, fieldInfo: DevExpress.common.grids.ColumnCustomizeTextArg ) => string; /** * Binds the column to a field of the dataSource. */ dataField?: string | undefined; /** * Converts column values to a different data type. */ dataType?: DevExpress.common.DataType | undefined; /** * Configures the default UI component used for editing. */ editorOptions?: any; /** * In a boolean column, replaces all false items with a specified text. */ falseText?: string; /** * Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are `true`. */ filterType?: DevExpress.common.grids.FilterType; /** * Specifies the filter value. */ filterValue?: any | undefined; /** * Specifies the values in the header filter. */ filterValues?: Array; /** * Configures the form item that the field produces in the editing state. */ formItem?: DevExpress.ui.dxForm.SimpleItem; /** * Formats a value before it is displayed in a field. */ format?: DevExpress.common.core.localization.Format; /** * Specifies data settings for the header filter. */ headerFilter?: DevExpress.common.grids.ColumnHeaderFilter | undefined; /** * Specifies the column's unique identifier. If not set in code, this value is inherited from the dataField. */ name?: string | undefined; /** * Specifies a function to be invoked after the user has edited a field value, but before it is saved in the data source. */ setFieldValue?: ( this: Column, newData: DevExpress.core.DeepPartial, value: any, currentCardData: TCardData ) => void | PromiseLike; /** * Specifies whether the column chooser can contain the column header. */ showInColumnChooser?: boolean; /** * Specifies the index according to which columns participate in sorting. */ sortIndex?: number | undefined; /** * Specifies the sort order of column values. */ sortOrder?: DevExpress.common.SortOrder | undefined; /** * Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client. */ sortingMethod?: | ((this: Column, value1: any, value2: any) => number) | undefined; /** * In a boolean column, replaces all true items with the specified text. */ trueText?: string; /** * Specifies validation rules to be checked when field values are updated. */ validationRules?: Array; /** * Specifies whether the column is visible. */ visible?: boolean; /** * Specifies the position of the column among other columns in the resulting UI component. */ visibleIndex?: number | undefined; /** * Specifies a custom template for the field. */ fieldTemplate?: | template | (( data: FieldTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for the field caption. */ fieldCaptionTemplate?: | template | (( data: FieldTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for the field value. */ fieldValueTemplate?: | template | (( data: FieldTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * Specifies a custom template for the header item. */ headerItemTemplate?: | template | (( data: ColumnTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * CSS class name applied to header item elements. */ headerItemCssClass?: string; }; /** * The texts displayed when editing a card. */ export type EditingTexts = { /** * Specifies the text of the button that adds a card. */ addCard?: string; /** * Specifies the text of the deletion confirmation message. */ confirmDeleteMessage?: string; /** * Specifies the title text of the pop-up deletion confirmation. */ confirmDeleteTitle?: string; /** * Specifies the text of the button that invokes card deletion. */ deleteCard?: string; /** * Specifies the text of the button that invokes card editing. */ editCard?: string; /** * Specifies the text of the button that saves the edited card. */ saveCard?: string; }; /** * Information about the field. */ export type FieldInfo = { /** * The field value. */ value: any; /** * Specifies the display value. */ displayValue: any; /** * The field text. */ text: string; /** * The column associated with the field. */ column: Column; /** * The field index. */ index: number; /** * Specifies which card the field belongs to. */ card: CardInfo; }; /** * Configures the header panel. */ export type HeaderPanel = { /** * Configures item dragging. */ dragging?: { /** * Specifies how to highlight the header item's drop position. */ dropFeedbackMode?: DevExpress.common.DragHighlight; /** * Specifies the scrolling speed when dragging an item beyond the viewport. */ scrollSpeed?: number; /** * Specifies the distance in pixels from the edge of viewport at which scrolling should start. */ scrollSensitivity?: number; /** * A function that is called when the dragged item's position changes. */ onDragChange?: (e: any) => void; /** * A function that is called when the drag gesture is finished. */ onDragEnd?: (e: any) => void; /** * A function that is called every time a draggable item is moved. */ onDragMove?: (e: any) => void; /** * A function that is called when a drag gesture is initialized. */ onDragStart?: (e: any) => void; /** * A function that is called when a draggable item is removed. */ onRemove?: (e: any) => void; /** * A function that is called when the draggable items are reordered. */ onReorder?: (e: any) => void; }; /** * Specifies whether the header panel is visible. */ visible?: boolean; /** * Specifies a custom template for header panel items. */ itemTemplate?: | template | (( data: ColumnTemplateData, container: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement); /** * CSS class name applied to item root elements. */ itemCssClass?: string; }; /** * Configures paging. */ export type Paging = { /** * Enables paging. */ enabled?: boolean; /** * Specifies the page to be displayed using a zero-based index. */ pageIndex?: number; /** * Specifies the page size. */ pageSize?: number; }; /** * Notifies CardView of the server's data processing operations. */ export type RemoteOperations = { /** * Specifies whether filtering must be performed on the server. */ filtering?: boolean; /** * Specifies whether paging must be performed on the server. */ paging?: boolean; /** * Specifies whether sorting must be performed on the server. */ sorting?: boolean; /** * Specifies whether grouping must be performed on the server. */ grouping?: boolean; }; /** * Configures the toolbar. */ export type Toolbar = { /** * Configures toolbar items. */ items?: Array; /** * Specifies whether the toolbar is visible. */ visible?: boolean | undefined; /** * Specifies whether the toolbar responds to user interaction. */ disabled?: boolean; /** * Specifies whether the toolbar arranges items into multiple lines when their combined width exceeds the toolbar width. */ multiline?: boolean; }; /** * Configures toolbar items. */ export type ToolbarItem = dxToolbarItem & { /** * Specifies the name of the predefined toolbar item. */ name?: PredefinedToolbarItem | string; /** * Specifies toolbar item location. */ location?: DevExpress.common.ToolbarItemLocation; }; } declare module DevExpress.ui.dxChat { /** * A configuration object for an alert. */ export type Alert = { /** * Alert's identification number or string. */ id?: number | string; /** * The alert's message. */ message?: string; }; /** * Configures image message. */ export type ImageMessage = MessageBase & { /** * Specifies the image source. Accepts URLs and Base64 strings. Only applies to `image` type messages. */ src?: string; /** * Image alternative text. Specifies the value of the image `alt` attributes. Screen readers utilize this property when image messages are focused. Only applies to `image` type messages. */ alt?: string; }; /** * A configuration object for a message. */ export type Message = TextMessage | ImageMessage; /** * A configuration object for a message. * @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 MessageBase = { /** * Message's identification number or string. */ id?: number | string; /** * The message type. */ type?: 'text' | 'image' | undefined; /** * A timestamp of when the message was sent. */ timestamp?: Date | number | string; /** * A user who is the author of the message. */ author?: User; /** * Marks a message as deleted in the UI. */ isDeleted?: boolean; [key: string]: any; }; /** * Configures a text message. */ export type TextMessage = MessageBase & { /** * The message text. Only applies to `text` type messages. */ text?: string; /** * Marks a message as edited in the UI. */ isEdited?: boolean; }; /** * A configuration object for a user. */ export type User = { /** * User's identification number or string. */ id?: number | string; /** * A user's name displayed in the chat. */ name?: string; /** * An avatar URL. */ avatarUrl?: string; /** * `alt` attribute for avatar image. */ avatarAlt?: string; }; } declare module DevExpress.ui.dxContextMenu { export type Item = dxContextMenuItem; } declare module DevExpress.ui.dxDataGrid { /** * Configures the toolbar. */ export type Toolbar = { /** * Configures toolbar items. */ items?: Array; /** * Specifies whether the toolbar is visible. */ visible?: boolean | undefined; /** * Specifies whether the toolbar responds to user interaction. */ disabled?: boolean; }; /** * Configures toolbar items. */ export type ToolbarItem = dxToolbarItem & { /** * A name used to identify the toolbar item. */ name?: DataGridPredefinedToolbarItem | string; /** * Specifies a location for the item on the toolbar. */ location?: DevExpress.common.ToolbarItemLocation; }; } declare module DevExpress.ui.dxDiagram { export type AutoZoomMode = 'fitContent' | 'fitWidth' | 'disabled'; export type Command = | 'separator' | 'exportSvg' | 'exportPng' | 'exportJpg' | 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'selectAll' | 'delete' | 'fontName' | 'fontSize' | 'bold' | 'italic' | 'underline' | 'fontColor' | 'lineStyle' | 'lineWidth' | 'lineColor' | 'fillColor' | 'textAlignLeft' | 'textAlignCenter' | 'textAlignRight' | 'lock' | 'unlock' | 'sendToBack' | 'bringToFront' | 'insertShapeImage' | 'editShapeImage' | 'deleteShapeImage' | 'connectorLineType' | 'connectorLineStart' | 'connectorLineEnd' | 'layoutTreeTopToBottom' | 'layoutTreeBottomToTop' | 'layoutTreeLeftToRight' | 'layoutTreeRightToLeft' | 'layoutLayeredTopToBottom' | 'layoutLayeredBottomToTop' | 'layoutLayeredLeftToRight' | 'layoutLayeredRightToLeft' | 'fullScreen' | 'zoomLevel' | 'showGrid' | 'snapToGrid' | 'gridSize' | 'units' | 'pageSize' | 'pageOrientation' | 'pageColor' | 'simpleView' | 'toolbox'; export type ConnectorLineEnd = | 'none' | 'arrow' | 'outlinedTriangle' | 'filledTriangle'; export type ConnectorLineType = 'straight' | 'orthogonal'; export type ConnectorPosition = 'start' | 'end'; /** * An object that provides information about a custom command in the Diagram UI component. */ export type CustomCommand = { /** * Specifies the custom command's identifier. */ name?: string | Command; /** * Specifies the custom command's text and tooltip text. */ text?: string; /** * Specifies the custom command's icon. */ icon?: string; /** * Lists command sub items. */ items?: Array; /** * Specifies a location for the command or separator on the main toolbar. */ location?: DevExpress.common.ToolbarItemLocation; }; export type DataLayoutType = 'auto' | 'off' | 'tree' | 'layered'; export type DiagramExportFormat = 'svg' | 'png' | 'jpg'; /** * An object that provides information about an item (shape or connector) in the Diagram UI component. */ export type Item = dxDiagramItem; export type ItemType = 'shape' | 'connector'; export type ModelOperation = | 'addShape' | 'addShapeFromToolbox' | 'deleteShape' | 'deleteConnector' | 'changeConnection' | 'changeConnectorPoints' | 'beforeChangeShapeText' | 'changeShapeText' | 'beforeChangeConnectorText' | 'changeConnectorText' | 'resizeShape' | 'moveShape'; export type PanelVisibility = 'auto' | 'visible' | 'collapsed' | 'disabled'; export type RequestEditOperationReason = | 'checkUIElementAvailability' | 'modelModification'; export type ShapeCategory = | 'general' | 'flowchart' | 'orgChart' | 'containers' | 'custom'; export type ShapeType = | 'text' | 'rectangle' | 'ellipse' | 'cross' | 'triangle' | 'diamond' | 'heart' | 'pentagon' | 'hexagon' | 'octagon' | 'star' | 'arrowLeft' | 'arrowTop' | 'arrowRight' | 'arrowBottom' | 'arrowNorthSouth' | 'arrowEastWest' | 'process' | 'decision' | 'terminator' | 'predefinedProcess' | 'document' | 'multipleDocuments' | 'manualInput' | 'preparation' | 'data' | 'database' | 'hardDisk' | 'internalStorage' | 'paperTape' | 'manualOperation' | 'delay' | 'storedData' | 'display' | 'merge' | 'connector' | 'or' | 'summingJunction' | 'verticalContainer' | 'horizontalContainer' | 'cardWithImageOnLeft' | 'cardWithImageOnTop' | 'cardWithImageOnRight'; export type ToolboxDisplayMode = 'icons' | 'texts'; export type Units = 'in' | 'cm' | 'px'; } declare module DevExpress.ui.dxDropDownButton { export type Item = dxDropDownButtonItem; } declare module DevExpress.ui.dxFileManager { export type ContextMenuItem = dxFileManagerContextMenuItem; export type ToolbarItem = dxFileManagerToolbarItem; } declare module DevExpress.ui.dxForm { export type ButtonItem = dxFormButtonItem; export type EmptyItem = dxFormEmptyItem; export type GroupItem = dxFormGroupItem; export type Item = | SimpleItem | GroupItem | TabbedItem | EmptyItem | ButtonItem; export type SimpleItem = dxFormSimpleItem; export type TabbedItem = dxFormTabbedItem; } declare module DevExpress.ui.dxGallery { export type Item = dxGalleryItem; } declare module DevExpress.ui.dxGantt { export type ContextMenuItem = dxGanttContextMenuItem; export type ToolbarItem = dxGanttToolbarItem; } declare module DevExpress.ui.dxHtmlEditor { /** * Specifies a 'change style' command for the 'ai' toolbar item. */ export type AIChangeStyleCommand = AICommandBase< 'changeStyle', (AIChangeStyleOption | string)[] >; /** * Specifies a 'change tone' command for the 'ai' toolbar item. */ export type AIChangeToneCommand = AICommandBase< 'changeTone', (AIChangeToneOption | string)[] >; /** * The union of all command types. */ export type AICommand = | AICommandBase<'summarize', any> | AICommandBase<'proofread', any> | AICommandBase<'expand', any> | AICommandBase<'shorten', any> | AICommandBase<'askAI', any> | AIChangeStyleCommand | AIChangeToneCommand | AITranslateCommand | AICustomCommand; /** * Specifies basic options for the 'ai' toolbar item commands. * @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 AICommandBase< CommandName extends AICommandNameExtended, CommandOptions = undefined > { /** * The command name. */ name: AICommandNameExtended; /** * The command title. */ text?: string; /** * Command options. */ options?: CommandOptions; } /** * Specifies a custom command for the 'ai' toolbar item. */ export interface AICustomCommand extends AICommandBase<'custom', string[]> { /** * A custom prompt. */ prompt: (param?: string) => string; /** * The command title. */ text: string; } /** * The 'ai' toolbar item. */ export interface AIToolbarItem extends Omit< DevExpress.ui.dxToolbar.Item, | 'menuItemTemplate' | 'showText' | 'widget' | 'options' | 'template' | 'html' > { /** * The toolbar item name. */ name: 'ai'; /** * An array of AI commands. */ commands?: Array; } /** * Specifies a 'translate' command for the 'ai' toolbar item. */ export type AITranslateCommand = AICommandBase< 'translate', (AITranslateOption | string)[] >; export type ContextMenuItem = dxHtmlEditorTableContextMenuItem; /** * An object that configures converter settings. */ export type Converter = { /** * A function that converts an HTML Editor value from a markup language to HTML. */ toHtml?: (value: string) => string; /** * A function that converts an HTML Editor value from HTML to another markup language. */ fromHtml?: (value: string) => string; }; export type ImageUploadTab = dxHtmlEditorImageUploadTabItem; export type ToolbarItem = dxHtmlEditorToolbarItem | AIToolbarItem; } declare module DevExpress.ui.dxList { export type Item = dxListItem; } declare module DevExpress.ui.dxMenu { export type Item = dxMenuItem; } declare module DevExpress.ui.dxMultiView { export type Item = dxMultiViewItem; } declare module DevExpress.ui.dxOverlay { /** * Specifies the base z-index for all overlay UI components. */ export function baseZIndex(zIndex: number): void; } declare module DevExpress.ui.dxPivotGrid { export type Cell = dxPivotGridPivotGridCell; } declare module DevExpress.ui.dxPopup { /** * @deprecated Use ToolbarItem instead * @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 dxPopupToolbarItem = ToolbarItem; /** * */ export interface ToolbarItem extends DevExpress.ui.dxToolbar.Item { /** * Specifies whether the item is displayed on a top or bottom toolbar. */ toolbar?: ToolbarLocation; } } declare module DevExpress.ui.dxResponsiveBox { export type Item = dxResponsiveBoxItem; } declare module DevExpress.ui.dxScheduler { /** * */ export type DateNavigatorItemProperties = dxButtonGroupOptions & { /** * */ items: Array; }; /** * Configures the toolbar. */ export type Toolbar = { /** * Configures toolbar items. */ items?: Array; /** * Specifies whether the toolbar is visible. */ visible?: boolean | undefined; /** * Specifies whether the toolbar arranges items into multiple lines when their combined width exceeds the toolbar width. */ multiline?: boolean; /** * Specifies whether the toolbar responds to user interaction. */ disabled?: boolean; }; /** * Configures toolbar items. */ export type ToolbarItem = dxToolbarItem & { /** * Specifies the name of the predefined toolbar item. */ name?: SchedulerPredefinedToolbarItem; /** * Configures the DevExtreme UI component used as a toolbar item. */ options?: DateNavigatorItemProperties | Object; /** * Specifies toolbar item location. */ location?: DevExpress.common.ToolbarItemLocation; }; } declare module DevExpress.ui.dxSplitter { export type Item = dxSplitterItem; } declare module DevExpress.ui.dxStepper { export type Item = dxStepperItem; } declare module DevExpress.ui.dxTabPanel { export type Item = dxTabPanelItem; } declare module DevExpress.ui.dxTabs { export type Item = dxTabsItem; } declare module DevExpress.ui.dxTileView { export type Item = dxTileViewItem; } declare module DevExpress.ui.dxToolbar { export type Item = dxToolbarItem; } declare module DevExpress.ui.dxTreeList { /** * Configures the toolbar. */ export type Toolbar = { /** * Configures toolbar items. */ items?: Array; /** * Specifies whether the toolbar is visible. */ visible?: boolean | undefined; /** * Specifies whether the toolbar responds to user interaction. */ disabled?: boolean; }; /** * Configures toolbar items. * @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 ToolbarItem extends dxToolbarItem { /** * A name used to identify the toolbar item. */ name?: TreeListPredefinedToolbarItem | string; /** * Specifies a location for the item on the toolbar. */ location?: DevExpress.common.ToolbarItemLocation; } } declare module DevExpress.ui.dxTreeView { export type Item = dxTreeViewItem; } declare module DevExpress.viz { /** * An object that provides information about a bar in the BarGauge UI component. * @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 BarGaugeBarInfo { /** * The bar's hexadecimal color code. */ color?: string; /** * The bar's zero-based index. Bars closest to the gauge's center have higher indexes. */ index?: number; /** * The bar's value. */ value?: number; } /** * @deprecated Use LegendItem instead * @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 BarGaugeLegendItem extends DevExpress.common.charts.BaseLegendItem { /** * The bar that the legend item represents. */ item?: BarGaugeBarInfo; } /** * A base class for all chart UI components included in the ChartJS library. * @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 BaseChart extends BaseWidget { /** * Deselects the chart's selected series. The series is displayed in an initial style. */ clearSelection(): void; /** * Gets all the series. */ getAllSeries(): Array; getDataSource(): DevExpress.common.data.DataSource; /** * Gets a series with a specific name. */ getSeriesByName(seriesName: any): chartSeriesObject; /** * Gets a series with a specific index. */ getSeriesByPos(seriesIndex: number): chartSeriesObject; /** * Hides all UI component tooltips. */ hideTooltip(): void; /** * Reloads data and repaints the UI component. */ refresh(): void; render(): void; /** * Redraws the UI component. */ render(renderOptions: any): void; } module BaseChart { /** * * @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 PointInteractionInfo< TPoint extends basePointObject = basePointObject > { /** * */ readonly target: TPoint; } /** * * @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 TooltipInfo< TPoint extends basePointObject = basePointObject > { /** * */ target?: TPoint | dxChartAnnotationConfig | any; } } /** * Specifies adaptive layout 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 interface BaseChartAdaptiveLayout { /** * Specifies the minimum container height at which the layout begins to adapt. */ height?: number; /** * Specifies whether point labels should be kept when the UI component adapts the layout. */ keepLabels?: boolean; /** * Specifies the minimum container width at which the layout begins to adapt. */ width?: number; } /** * * @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 BaseChartAnnotationConfig extends BaseWidgetAnnotationConfig { /** * Positions the annotation relative to a specific argument. */ argument?: number | Date | string | undefined; /** * Anchors the annotation to a series point. Accepts the name of the point's series. */ series?: string | undefined; /** * Positions the annotation relative to a value on the specified value axis. */ value?: number | Date | string | undefined; } /** * Specifies properties of the legend. * @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 BaseChartLegend extends DevExpress.common.charts.BaseLegend { /** * Allows you to change only the order, text, and visibility of legend items. */ customizeItems?: ( items: Array ) => Array; /** * Specifies an SVG element that serves as a custom legend item marker. */ markerTemplate?: | template | (( legendItem: DevExpress.common.charts.LegendItem, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; } /** * * @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 BaseChartOptions< TComponent, TPoint extends basePointObject = basePointObject > extends BaseWidgetOptions { /** * Specifies adaptive layout properties. */ adaptiveLayout?: BaseChartAdaptiveLayout; /** * Specifies animation properties. */ animation?: | { /** * Specifies how long the animation runs in milliseconds. */ duration?: number; /** * Specifies the easing function of the animation. */ easing?: DevExpress.common.charts.AnimationEaseMode; /** * Enables the animation in the UI component. */ enabled?: boolean; /** * Specifies how many series points the UI component should have before the animation will be disabled. */ maxPointCountSupported?: number; } | boolean; /** * Customizes the appearance of an individual point label. */ customizeLabel?: (pointInfo: any) => DevExpress.common.charts.SeriesLabel; /** * Customizes the appearance of an individual series point. */ customizePoint?: (pointInfo: any) => DevExpress.common.charts.SeriesPoint; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies properties of the legend. */ legend?: BaseChartLegend; /** * A function that is executed when all series are ready. */ onDone?: (e: DevExpress.common.core.events.EventInfo) => void; /** * A function that is executed when a series point is clicked or tapped. */ onPointClick?: | (( e: DevExpress.common.core.events.NativeEventInfo< TComponent, MouseEvent | PointerEvent > & DevExpress.viz.BaseChart.PointInteractionInfo ) => void) | string; /** * A function that is executed after the pointer enters or leaves a series point. */ onPointHoverChanged?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo ) => void; /** * A function that is executed when a series point is selected or selection is canceled. */ onPointSelectionChanged?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo ) => void; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo ) => void; /** * A function that is executed when a tooltip appears. */ onTooltipShown?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo ) => void; /** * Sets the palette to be used for colorizing series and their elements. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart UI component) or points in a series (in the PieChart UI component). */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * Specifies whether a single point or multiple points can be selected in the chart. */ pointSelectionMode?: DevExpress.common.SingleOrMultiple; /** * Specifies properties for series. */ series?: any | Array | undefined; /** * Configures tooltips. */ tooltip?: BaseChartTooltip; } /** * Configures tooltips. * @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 BaseChartTooltip extends BaseWidgetTooltip { /** * Formats the point argument before it is displayed in the tooltip. To format the point value, use the format property. */ argumentFormat?: DevExpress.common.core.localization.Format | undefined; /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( pointInfo: any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Allows you to change tooltip appearance. */ customizeTooltip?: ((pointInfo: any) => any) | undefined; /** * Specifies whether the tooltip is shared across all series points with the same argument. */ shared?: boolean; /** * Allows users to interact with the tooltip content. */ interactive?: boolean; } /** * A gauge UI component. * @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 BaseGauge extends BaseWidget { /** * Gets subvalues. */ subvalues(): Array; /** * Updates subvalues. */ subvalues(subvalues: Array): void; /** * Gets the main value. */ value(): number; /** * Updates the main value. */ value(value: number): void; } module BaseGauge { export type GaugeIndicatorType = | 'circle' | 'rangeBar' | 'rectangle' | 'rectangleNeedle' | 'rhombus' | 'textCloud' | 'triangleMarker' | 'triangleNeedle' | 'twoColorNeedle'; /** * * @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 TooltipInfo { /** * */ target: any; } } /** * Specifies animation 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 interface BaseGaugeAnimation { /** * Determines how long animation runs. */ duration?: number; /** * Specifies the animation easing mode. */ easing?: DevExpress.common.charts.AnimationEaseMode; /** * Indicates whether or not animation is enabled. */ enabled?: boolean; } /** * Configures the loading indicator. * @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 BaseGaugeLoadingIndicator extends BaseWidgetLoadingIndicator { /** * Specifies whether the loading indicator should be displayed and hidden automatically. */ enabled?: 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 interface BaseGaugeOptions extends BaseWidgetOptions { /** * Specifies animation properties. */ animation?: BaseGaugeAnimation; /** * Specifies the color of the parent page element. */ containerBackgroundColor?: string; /** * Configures the loading indicator. */ loadingIndicator?: BaseGaugeLoadingIndicator; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo ) => void; /** * A function that is executed when a tooltip appears. */ onTooltipShown?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo ) => void; /** * Specifies properties of the gauge's range container. */ rangeContainer?: BaseGaugeRangeContainer; /** * Specifies properties of the gauge's scale. */ scale?: BaseGaugeScale; /** * Specifies a set of subvalues to be designated by the subvalue indicators. */ subvalues?: Array; /** * Configures tooltips. */ tooltip?: BaseGaugeTooltip; /** * Specifies the main value on a gauge. */ value?: number | undefined; } /** * Specifies properties of the gauge's range container. * @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 BaseGaugeRangeContainer { /** * Specifies a range container's background color. */ backgroundColor?: string | DevExpress.common.charts.ChartsColor; /** * Specifies the offset of the range container from an invisible scale line in pixels. */ offset?: number; /** * Specifies the palette to be used for colorizing ranges in the range container. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of ranges in the range container. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * An array of objects representing ranges contained in the range container. */ ranges?: Array<{ /** * Specifies the color of a range. */ color?: string | DevExpress.common.charts.ChartsColor; /** * Specifies an end value of a range. */ endValue?: number; /** * Specifies a start value of a range. */ startValue?: number; }>; } /** * Specifies properties of the gauge's scale. * @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 BaseGaugeScale { /** * Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only. */ allowDecimals?: boolean | undefined; /** * Specifies an array of custom minor ticks. */ customMinorTicks?: Array; /** * Specifies an array of custom major ticks. */ customTicks?: Array; /** * Specifies the end value for the scale of the gauge. */ endValue?: number; /** * Specifies common properties for scale labels. */ label?: BaseGaugeScaleLabel; /** * Specifies properties of the gauge's minor ticks. */ minorTick?: { /** * Specifies the color of the scale's minor ticks. */ color?: string; /** * Specifies the length of the scale's minor ticks. */ length?: number; /** * Specifies the opacity of the scale's minor ticks. */ opacity?: number; /** * Indicates whether scale minor ticks are visible or not. */ visible?: boolean; /** * Specifies the width of the scale's minor ticks. */ width?: number; }; /** * Specifies an interval between minor ticks. */ minorTickInterval?: number | undefined; /** * Specifies the minimum distance between two neighboring major ticks in pixels. */ scaleDivisionFactor?: number; /** * Specifies the start value for the scale of the gauge. */ startValue?: number; /** * Specifies properties of the gauge's major ticks. */ tick?: { /** * Specifies the color of the scale's major ticks. */ color?: string; /** * Specifies the length of the scale's major ticks. */ length?: number; /** * Specifies the opacity of the scale's major ticks. */ opacity?: number; /** * Indicates whether scale major ticks are visible or not. */ visible?: boolean; /** * Specifies the width of the scale's major ticks. */ width?: number; }; /** * Specifies an interval between major ticks. */ tickInterval?: number | undefined; } /** * Specifies common properties for scale labels. * @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 BaseGaugeScaleLabel { /** * Specifies a callback function that returns the text to be displayed in scale labels. */ customizeText?: (scaleValue: { value?: number; valueText?: string; }) => string; /** * Specifies font properties for the text displayed in the scale labels of the gauge. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a scale label. Accepts only numeric formats. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Decides how to arrange scale labels when there is not enough space to keep all of them. */ overlappingBehavior?: DevExpress.common.charts.LabelOverlap; /** * Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container. */ useRangeColors?: boolean; /** * Specifies whether or not scale labels are visible on the gauge. */ visible?: boolean; } /** * Configures tooltips. * @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 BaseGaugeTooltip extends BaseWidgetTooltip { /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( scaleValue: { value?: number; valueText?: string }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Allows you to change the appearance of specified tooltips. */ customizeTooltip?: | ((scaleValue: { value?: number; valueText?: string }) => any) | undefined; /** * */ interactive?: boolean; } /** * This section describes the Label object, which represents a point label. * @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 baseLabelObject { /** * Gets the parameters of the label's minimum bounding rectangle (MBR). */ getBoundingRect(): any; /** * Moves label to the specified location. */ shift(x: number, y: number): this; /** * Hides the point label. */ hide(): void; /** * Hides the point label and keeps it invisible until the show() method is called. */ hide(holdInvisible: boolean): void; /** * Checks whether the point label is visible. */ isVisible(): boolean; /** * Shows the point label. */ show(): void; /** * Shows the point label and keeps it visible until the hide() method is called. */ show(holdVisible: boolean): void; } /** * This section describes the Point object, which represents a series point. * @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 basePointObject { /** * Switches the point from the hover state back to normal. */ clearHover(): void; /** * Deselects the point. */ clearSelection(): void; /** * Contains the data object that the series point represents. */ data?: any; /** * Provides information about the state of the point object. */ fullState?: number; /** * Gets the color of a particular point. */ getColor(): string; /** * Allows you to obtain the label(s) of the series point. */ getLabel(): baseLabelObject & Array; /** * Hides the tooltip of the point. */ hideTooltip(): void; /** * Switches the point into the hover state, the same as when a user places the mouse pointer on it. */ hover(): void; /** * Provides information about the hover state of a point. */ isHovered(): boolean; /** * Provides information about the selection state of a point. */ isSelected(): boolean; /** * Returns the point's argument value that was set in the data source. */ originalArgument?: string | number | Date; /** * Returns the point's value that was set in the data source. */ originalValue?: string | number | Date; /** * Selects the point. The point is displayed in a 'selected' style until another point is selected or the current point is deselected programmatically. */ select(): void; /** * Returns the series object to which the point belongs. */ series?: any; /** * Shows the tooltip of the point. */ showTooltip(): void; /** * Returns the tag of the point. */ tag?: any; } /** * This section describes the Series object, which represents a series. * @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 baseSeriesObject { /** * Switches the series from the hover state back to normal. */ clearHover(): void; /** * Cancels the selection of this particular series. The series is displayed in its initial style. */ clearSelection(): void; /** * Deselects the specified point. The point is displayed in an initial style. */ deselectPoint(point: basePointObject): void; /** * Provides information about the state of the series object. */ fullState?: number; /** * Gets all points in the series. */ getAllPoints(): Array; /** * Gets the color of a particular series. */ getColor(): string; /** * Gets a series point with the specified index. */ getPointByPos(positionIndex: number): basePointObject; /** * Gets a series point with the specified argument value. */ getPointsByArg(pointArg: number | string | Date): Array; /** * Gets visible series points. */ getVisiblePoints(): Array; /** * Hides a series at runtime. */ hide(): void; /** * Switches the series into the hover state, the same as when a user places the mouse pointer on it. */ hover(): void; /** * Provides information about the hover state of a series. */ isHovered(): boolean; /** * Provides information about the selection state of a series. */ isSelected(): boolean; /** * Provides information about the visibility state of a series. */ isVisible(): boolean; /** * Returns the name of the series. */ name?: any; /** * Selects the series. */ select(): void; /** * Selects the specified point. The point is displayed in a 'selected' style. */ selectPoint(point: basePointObject): void; /** * Makes a particular series visible. */ show(): void; /** * Returns the tag of the series. */ tag?: any; /** * Returns the type of the series. */ type?: string; } /** * Overridden by descriptions for particular 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 BaseSparkline extends BaseWidget { /** * Hides the loading indicator. */ hideLoadingIndicator(): void; /** * Shows the loading indicator. */ showLoadingIndicator(): 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 BaseSparklineOptions extends BaseWidgetOptions { /** * Configures the exporting and printing features. */ export?: BaseWidgetExport; /** * Configures the loading indicator. */ loadingIndicator?: BaseWidgetLoadingIndicator; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden?: ( e: DevExpress.common.core.events.EventInfo ) => void; /** * A function that is executed when a tooltip appears. */ onTooltipShown?: ( e: DevExpress.common.core.events.EventInfo ) => void; /** * Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. */ redrawOnResize?: boolean; /** * Configures the UI component's title. */ title?: BaseWidgetTitle | string; /** * Configures the tooltip. */ tooltip?: BaseSparklineTooltip; } /** * Configures the tooltip. * @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 BaseSparklineTooltip extends BaseWidgetTooltip { /** * Specifies a custom template for tooltips. */ contentTemplate?: | template | (( pointsInfo: any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Allows you to change tooltip appearance. */ customizeTooltip?: ((pointsInfo: any) => any) | undefined; /** * Specifies whether a tooltip is enabled. */ enabled?: boolean; /** * */ interactive?: boolean; } /** * This section describes properties and methods that are common to all 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 BaseWidget extends DOMComponent { /** * Specifies the device-dependent default configuration properties for this component. * @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. */ static defaultOptions( rule: DefaultOptionsRule ): void; /** * Exports the UI component. */ exportTo(fileName: string, format: string): void; /** * Gets the current UI component size. */ getSize(): BaseWidgetSize; /** * Hides the loading indicator. */ hideLoadingIndicator(): void; /** * Opens the browser's print window. */ print(): void; /** * Redraws the UI component. */ render(): void; /** * Shows the loading indicator. */ showLoadingIndicator(): void; /** * Gets the UI component's SVG markup. */ svg(): string; } module BaseWidget { /** * * @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 ExportInfo { /** * */ readonly fileName: string; /** * */ readonly format: 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 FileSavingEventInfo = DevExpress.common.core.events.Cancelable & { /** * */ readonly component: T; /** * */ readonly element: DevExpress.core.DxElement; /** * */ readonly fileName: string; /** * */ readonly format: string; /** * */ readonly data: Blob; }; /** * * @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 IncidentInfo { /** * */ readonly target: 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 interface BaseWidgetAnnotationConfig { /** * Specifies whether users can drag and drop the annotation. */ allowDragging?: boolean; /** * Specifies the length of the annotation's arrow in pixels. */ arrowLength?: number; /** * Specifies the width of the annotation's arrow at its junction with the annotation rectangle. */ arrowWidth?: number; /** * Configures the appearance of the annotation's border. */ border?: { /** * Colors the annotation's border. */ color?: string; /** * Makes the annotation's corners rounded. */ cornerRadius?: number; /** * Specifies the dash style of the annotation's border. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies the opacity of the annotation's border. */ opacity?: number | undefined; /** * Specifies the visibility of the annotation's border. */ visible?: boolean; /** * Specifies the width of the annotation's border in pixels. */ width?: number; }; /** * Specifies the color that fills the annotation. */ color?: string; /** * A container for custom data. */ data?: any; /** * Specifies the annotation's description in the tooltip. */ description?: string | undefined; /** * Specifies the annotation's font properties. Applies to text annotations only. */ font?: DevExpress.common.charts.Font; /** * Specifies the annotation's height in pixels. */ height?: number | undefined; /** * Configures the image to be displayed in the annotation. Applies only if the type is 'image'. */ image?: | string | { /** * Specifies the image's height in pixels. */ height?: number; /** * Specifies the image's URL. */ url?: string | undefined; /** * Specifies the image's width in pixels. */ width?: number; }; /** * Moves the annotation horizontally. */ offsetX?: number | undefined; /** * Moves the annotation vertically. */ offsetY?: number | undefined; /** * Specifies the annotation's opacity. */ opacity?: number; /** * Used with paddingTopBottom to generate an empty space around the annotation's text or image (specified in pixels). */ paddingLeftRight?: number; /** * Along with paddingLeftRight, generates an empty space around the annotation's text or image; specified in pixels. */ paddingTopBottom?: number; /** * Configures the annotation's shadows. */ shadow?: { /** * Specifies the blur distance of the shadows. A larger value increases the blur distance. */ blur?: number; /** * Colors the annotation's shadows. */ color?: string; /** * Moves the shadows horizontally. */ offsetX?: number; /** * Moves the shadows vertically. */ offsetY?: number; /** * Specifies the opacity of the shadows. */ opacity?: number; }; /** * Specifies the annotation's text. Applies only if the type is 'text'. */ text?: string | undefined; /** * Specifies what to do with the annotation's text when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Specifies whether the annotation tooltip is enabled. */ tooltipEnabled?: boolean; /** * Specifies whether the annotation displays text, an image, or a template. This is a required setting. */ type?: DevExpress.common.charts.AnnotationType | undefined; /** * Specifies the annotation's width in pixels. */ width?: number | undefined; /** * Specifies how to wrap the annotation's text if it does not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; /** * Used with y to position the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the UI component. */ x?: number | undefined; /** * Used with x to position the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the UI component. */ y?: number | undefined; } /** * Configures the exporting and printing features. * @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 BaseWidgetExport { /** * Specifies the color that will fill transparent regions in the resulting file or document. */ backgroundColor?: string; /** * Enables the client-side exporting in the UI component. */ enabled?: boolean; /** * Specifies a default name for the file to which the UI component will be exported. */ fileName?: string; /** * Specifies a set of export formats. */ formats?: Array; /** * Adds an empty space around the exported UI component; measured in pixels. */ margin?: number; /** * Enables the printing feature in the UI component. Applies only if the export.enabled property is true. */ printingEnabled?: boolean; /** * A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate). */ svgToCanvas?: | ((svg: SVGElement, canvas: HTMLCanvasElement) => PromiseLike) | undefined; } /** * Configures the loading indicator. * @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 BaseWidgetLoadingIndicator { /** * Colors the background of the loading indicator. */ backgroundColor?: string; /** * Specifies whether the loading indicator should be displayed and hidden automatically. */ enabled?: boolean; /** * Specifies font properties for the loading indicator. */ font?: DevExpress.common.charts.Font; /** * Allows you to change the loading indicator's visibility. */ show?: boolean; /** * Specifies the text to be displayed by the loading indicator. */ text?: string; } /** * Generates space around the UI component. * @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 BaseWidgetMargin { /** * Specifies the bottom margin of the UI component in pixels. */ bottom?: number; /** * Specifies the left margin of the UI component in pixels. */ left?: number; /** * Specifies the right margin of the UI component in pixels. */ right?: number; /** * Specifies the top margin of the UI component in pixels. */ top?: number; } /** * * @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 BaseWidgetOptions extends DOMComponentOptions { /** * Specifies whether the UI component responds to user interaction. */ disabled?: boolean; /** * Configures the exporting and printing features. */ export?: BaseWidgetExport; /** * Specifies the UI component's height. */ height?: number | string; /** * Configures the loading indicator. */ loadingIndicator?: BaseWidgetLoadingIndicator; /** * Generates space around the UI component. */ margin?: BaseWidgetMargin; /** * A function that is executed when the UI component's rendering has finished. */ onDrawn?: (e: DevExpress.common.core.events.EventInfo) => void; /** * A function that is executed after the UI component is exported. */ onExported?: ( e: DevExpress.common.core.events.EventInfo ) => void; /** * A function that is executed before the UI component is exported. */ onExporting?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo ) => void; /** * A function that is executed before a file with exported UI component is saved to the user's local storage. */ onFileSaving?: ( e: DevExpress.viz.BaseWidget.FileSavingEventInfo ) => void; /** * A function that is executed when an error or warning occurs. */ onIncidentOccurred?: ( e: DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo ) => void; /** * Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. */ pathModified?: boolean; /** * Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. */ redrawOnResize?: boolean; /** * Switches the UI component to a right-to-left representation. */ rtlEnabled?: boolean; /** * Specifies the UI component's size in pixels. */ size?: BaseWidgetSize | undefined; /** * Sets the name of the theme the UI component uses. */ theme?: DevExpress.common.charts.Theme; /** * Configures the UI component's title. */ title?: BaseWidgetTitle | string; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: BaseWidgetTooltip; /** * Specifies the UI component's width. */ width?: number | string; } /** * Specifies the UI component's size in pixels. * @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 BaseWidgetSize { /** * Specifies the height of the UI component in pixels. */ height?: number | undefined; /** * Specifies the width of the UI component in pixels. */ width?: number | undefined; } /** * Configures the UI component's title. * @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 BaseWidgetTitle { /** * Specifies font properties for the title. */ font?: DevExpress.common.charts.Font; /** * Specifies the title's alignment in a horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Generates space around the title. */ margin?: | number | { /** * Specifies the bottom margin of the title. */ bottom?: number; /** * Specifies the left margin of the title. */ left?: number; /** * Specifies the right margin of the title. */ right?: number; /** * Specifies the top margin of the title. */ top?: number; }; /** * Reserves a pixel-measured space for the title. */ placeholderSize?: number | undefined; /** * Configures the UI component's subtitle. */ subtitle?: | { /** * Specifies font properties for the subtitle. */ font?: DevExpress.common.charts.Font; /** * Specifies the distance between the title and subtitle in pixels. */ offset?: number; /** * Specifies text for the subtitle. */ text?: string; /** * Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Specifies how to wrap the subtitle if it does not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; } | string; /** * Specifies the title's text. */ text?: string; /** * Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Specifies the title's alignment in a vertical direction. */ verticalAlignment?: DevExpress.common.VerticalEdge; /** * Specifies how to wrap the title if it does not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; } /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. * @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 BaseWidgetTooltip { /** * Specifies the length of a tooltip's arrow in pixels. */ arrowLength?: number; /** * Configures a tooltip's border. */ border?: { /** * Colors a tooltip's border. */ color?: string; /** * Specifies the dash style of a tooltip's border. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies the transparency of a tooltip's border. */ opacity?: number | undefined; /** * Specifies whether a tooltip's border is visible. */ visible?: boolean; /** * Specifies the width of a tooltip's border in pixels. */ width?: number; }; /** * Colors all tooltips. */ color?: string; /** * Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element. */ container?: string | DevExpress.core.UserDefinedElement | undefined; /** * Makes all the tooltip's corners rounded. */ cornerRadius?: number; /** * Enables tooltips. */ enabled?: boolean; /** * Specifies tooltips' font properties. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed it in a tooltip. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies tooltips' transparency. */ opacity?: number | undefined; /** * Generates an empty space, measured in pixels, between a tooltip's left/right border and its text. */ paddingLeftRight?: number; /** * Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text. */ paddingTopBottom?: number; /** * Configures a tooltip's shadow. */ shadow?: { /** * Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge. */ blur?: number; /** * Colors a tooltip's shadow. */ color?: string; /** * Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels. */ offsetX?: number; /** * Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels. */ offsetY?: number; /** * Specifies the transparency of a tooltip's shadow. */ opacity?: number; }; /** * Specifies a tooltip's z-index. */ zIndex?: number | undefined; } /** * This section describes the Axis object. This object represents a chart axis. * @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 chartAxisObject { /** * Gets the axis' displayed range. */ visualRange(): DevExpress.common.charts.VisualRange; /** * Sets the axis's displayed range. */ visualRange( visualRange: | Array | DevExpress.common.charts.VisualRange ): 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 chartPointAggregationInfoObject { /** * Contains the length of the aggregation interval in axis units (numbers or dates). If the interval is set in pixels (using the aggregationGroupWidth property), it will be converted to axis units. */ aggregationInterval?: any; /** * Contains data objects that were aggregated into this point. */ data?: Array; /** * Contains the end value of the interval to which the point belongs. */ intervalEnd?: any; /** * Contains the start value of the interval to which the point belongs. */ intervalStart?: any; } /** * This section describes the Point object, which represents a series point. * @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 chartPointObject extends basePointObject { /** * Provides information about the aggregation interval and the data objects that fall within it. */ aggregationInfo?: chartPointAggregationInfoObject; /** * Gets the parameters of the point's minimum bounding rectangle (MBR). */ getBoundingRect(): any; /** * Contains the close value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ originalCloseValue?: number | string; /** * Contains the high value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ originalHighValue?: number | string; /** * Contains the low value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ originalLowValue?: number | string; /** * Contains the first value of the point. This field is useful for points belonging to a series of the range area or range bar type only. */ originalMinValue?: string | number | Date; /** * Contains the open value of the point. This field is useful for points belonging to a series of the candle stick or stock type only. */ originalOpenValue?: number | string; /** * Contains the size of the bubble as it was set in the data source. This field is useful for points belonging to a series of the bubble type only. */ size?: number | string; } /** * Specifies properties for Chart UI component series. * @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 ChartSeries extends dxChartSeriesTypesCommonSeries { /** * Specifies the name that identifies the series. */ name?: string | undefined; /** * Specifies data about a series. */ tag?: any | undefined; /** * Sets the series type. */ type?: DevExpress.common.charts.SeriesType; } /** * This section describes the Series object, which represents a series. * @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 chartSeriesObject extends baseSeriesObject { /** * Returns the name of the value axis of the series. */ axis?: string; /** * The name of the series' barOverlapGroup. */ barOverlapGroup?: string; /** * Gets the argument axis to which the series belongs. */ getArgumentAxis(): chartAxisObject; /** * Gets the value axis to which the series belongs. */ getValueAxis(): chartAxisObject; /** * Returns the name of the series pane. */ pane?: string; /** * The name of the series' stack. */ stack?: string; } /** * A base object for gauge value and subvalue indicators. Includes the properties of indicators of all types. * @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 CommonIndicator { /** * Specifies the length of an arrow for the indicator of the textCloud type in pixels. */ arrowLength?: number; /** * Specifies the background color for the indicator of the rangeBar type. */ backgroundColor?: string; /** * Specifies the base value for the indicator of the rangeBar type. */ baseValue?: number | undefined; /** * Specifies a radius small enough for the indicator to begin adapting. */ beginAdaptingAtRadius?: number; /** * Specifies the color of the indicator. */ color?: string | DevExpress.common.charts.ChartsColor; /** * Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation property is 'vertical'. */ horizontalOrientation?: DevExpress.common.HorizontalEdge; /** * Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type. */ indentFromCenter?: number; /** * Specifies the indicator length. */ length?: number; /** * Specifies the distance between the indicator and the invisible scale line. */ offset?: number; /** * Sets the palette to be used to colorize indicators differently. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies the second color for the indicator of the twoColorNeedle type. */ secondColor?: string; /** * Specifies the length of a twoNeedleColor type indicator tip as a percentage. */ secondFraction?: number; /** * Specifies the range bar size for an indicator of the rangeBar type. */ size?: number; /** * Specifies the inner diameter in pixels, so that the spindle has the shape of a ring. */ spindleGapSize?: number; /** * Specifies the spindle's diameter in pixels for the indicator of a needle-like type. */ spindleSize?: number; /** * Specifies the appearance of the text displayed in an indicator of the rangeBar type. */ text?: { /** * Specifies a callback function that returns the text to be displayed in an indicator. */ customizeText?: | ((indicatedValue: { value?: number; valueText?: string }) => string) | undefined; /** * Specifies font properties for the text displayed by the indicator. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in an indicator. Accepts only numeric formats. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies the range bar's label indent in pixels. */ indent?: number; }; /** * Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation property is 'horizontal'. */ verticalOrientation?: DevExpress.common.VerticalEdge; /** * Specifies the width of an indicator in pixels. */ width?: number; } /** * Gets the current palette's name. */ export function currentPalette(): string; /** * Changes the current palette for all data visualization UI components on the page. */ export function currentPalette(paletteName: string): void; /** * Gets the current theme's name. */ export function currentTheme(): string; /** * Changes the current theme for all data visualization UI components on the page. The color scheme is defined separately. */ export function currentTheme(platform: string, colorScheme: string): void; /** * Changes the current theme for all data visualization UI components on the page. */ export function currentTheme(theme: string): void; /** * The BarGauge UI component contains several circular bars that each indicates a single value. */ export class dxBarGauge extends BaseWidget { /** * Gets all the values. */ values(): Array; /** * Updates all the values. */ values(values: Array): void; } module dxBarGauge { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * Configures the legend. */ export type Legend = DevExpress.common.charts.BaseLegend & { /** * Specifies the hint that appears when a user hovers the mouse pointer over a legend item. */ customizeHint?: (arg: { item?: BarGaugeBarInfo; text?: string; }) => string; /** * Allows you to change the order, text, and visibility of legend items. */ customizeItems?: (items: Array) => Array; /** * Customizes the text displayed by legend items. */ customizeText?: (arg: { item?: BarGaugeBarInfo; text?: string; }) => string; /** * Formats the item text before it is displayed. Accepts only numeric formats. When unspecified, it inherits the label's format. */ itemTextFormat?: DevExpress.common.core.localization.Format | undefined; /** * Specifies an SVG element that serves as a custom legend item marker. */ markerTemplate?: | template | (( legendItem: LegendItem, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies whether the legend is visible. */ visible?: boolean; }; /** * Configures the loading indicator. */ export type LoadingIndicator = BaseWidgetLoadingIndicator & { /** * Specifies whether the loading indicator should be displayed and hidden automatically. */ enabled?: boolean; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxBarGaugeOptions; /** * Configures tooltips. */ export type Tooltip = BaseWidgetTooltip & { /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( scaleValue: { value?: number; valueText?: string; index?: number }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Allows you to change tooltip appearance. */ customizeTooltip?: | ((scaleValue: { value?: number; valueText?: string; index?: number; }) => any) | undefined; /** * */ interactive?: boolean; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & TooltipInfo; /** * * @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 TooltipInfo { /** * */ target?: any; } /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & TooltipInfo; } /** * * @deprecated * @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 dxBarGaugeOptions extends BaseWidgetOptions { /** * Specifies animation properties. */ animation?: any; /** * Specifies a color for the remaining segment of the bar's track. */ backgroundColor?: string; /** * Specifies a distance between bars in pixels. */ barSpacing?: number; /** * Specifies a base value for bars. */ baseValue?: number; /** * Specifies an end value for the gauge's invisible scale. */ endValue?: number; /** * Defines the shape of the gauge's arc. */ geometry?: { /** * Specifies the end angle of the bar gauge's arc. */ endAngle?: number; /** * Specifies the start angle of the bar gauge's arc. */ startAngle?: number; }; /** * Specifies a custom template for content in the component's center. */ centerTemplate?: | template | (( component: dxBarGauge, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies the properties of the labels that accompany gauge bars. */ label?: { /** * Specifies a color for the label connector text. */ connectorColor?: string | undefined; /** * Specifies the width of the label connector in pixels. */ connectorWidth?: number; /** * Specifies a callback function that returns a text for labels. */ customizeText?: (barValue: { value?: number; valueText?: string; }) => string; /** * Specifies font properties for bar labels. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a label. Accepts only numeric formats. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies the distance between the upper bar and bar labels in pixels. */ indent?: number; /** * Specifies whether bar labels appear on a gauge or not. */ visible?: boolean; }; /** * Configures the legend. */ legend?: DevExpress.viz.dxBarGauge.Legend; /** * Configures the loading indicator. */ loadingIndicator?: DevExpress.viz.dxBarGauge.LoadingIndicator; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden?: (e: DevExpress.viz.dxBarGauge.TooltipHiddenEvent) => void; /** * A function that is executed when a tooltip appears. */ onTooltipShown?: (e: DevExpress.viz.dxBarGauge.TooltipShownEvent) => void; /** * Sets the palette to be used for colorizing bars in the gauge. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of bars in the gauge. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar. */ relativeInnerRadius?: number; /** * Specifies how the UI component should behave when bar labels overlap. */ resolveLabelOverlapping?: DevExpress.common.charts.ShiftLabelOverlap; /** * Specifies a start value for the gauge's invisible scale. */ startValue?: number; /** * Configures tooltips. */ tooltip?: DevExpress.viz.dxBarGauge.Tooltip; /** * Specifies the array of values to be indicated on a bar gauge. */ values?: Array; } /** * The Bullet UI component is useful when you need to compare a single measure to a target value. The UI component comprises a horizontal bar indicating the measure and a vertical line indicating the target value. */ export class dxBullet extends BaseSparkline {} module dxBullet { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxBulletOptions; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo; } /** * * @deprecated * @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 dxBulletOptions extends BaseSparklineOptions { /** * Specifies a color for the bullet bar. */ color?: string; /** * Specifies an end value for the invisible scale. */ endScaleValue?: number | undefined; /** * Specifies whether or not to show the target line. */ showTarget?: boolean; /** * Specifies whether or not to show the line indicating zero on the invisible scale. */ showZeroLevel?: boolean; /** * Specifies a start value for the invisible scale. */ startScaleValue?: number; /** * Specifies the value indicated by the target line. */ target?: number; /** * Specifies a color for both the target and zero level lines. */ targetColor?: string; /** * Specifies the width of the target line. */ targetWidth?: number; /** * Specifies the primary value indicated by the bullet bar. */ value?: number; } /** * The Chart is a UI component that visualizes data from a local or remote storage using a great variety of series types along with different interactive elements, such as tooltips, crosshair pointer, legend, etc. */ export class dxChart extends BaseChart { /** * Gets the argument axis. */ getArgumentAxis(): chartAxisObject; /** * Gets a value axis. */ getValueAxis(): chartAxisObject; /** * Gets a value axis with the specified name. */ getValueAxis(name: string): chartAxisObject; /** * Resets the visual ranges of both axes to the data range or the whole range if it is within the data range. [note] resetVisualRange() does not support multi-axis charts. */ resetVisualRange(): void; /** * Sets the argument axis' start and end values. */ zoomArgument( startValue: number | Date | string, endValue: number | Date | string ): void; } module dxChart { export type AggregatedPointsPosition = 'betweenTicks' | 'crossTicks'; /** * Configures the argument axis. */ export type ArgumentAxis = CommonAxisSettings & { /** * Specifies the length of aggregation intervals in pixels. Applies only to axes of continuous and logarithmic types. May be ignored in favor of the aggregationInterval property. */ aggregationGroupWidth?: number | undefined; /** * Specifies the length of aggregation intervals in axis units. Applies only to axes of continuous and logarithmic types. */ aggregationInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Casts arguments to a specified data type. */ argumentType?: DevExpress.common.charts.ChartsDataType | undefined; /** * Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the 'continuous' and 'logarithmic' types. */ axisDivisionFactor?: number; /** * Declares a scale break collection. Applies only if the axis' type is 'continuous' or 'logarithmic'. */ breaks?: Array; /** * Specifies the order of categories on an axis of the 'discrete' type. */ categories?: Array; /** * Specifies the appearance of those constant lines that belong to the argument axis. */ constantLineStyle?: ArgumentAxisConstantLineStyle; /** * Declares a collection of constant lines belonging to the argument axis. */ constantLines?: Array; /** * Specifies whether to force the axis to start and end on ticks. */ endOnTick?: boolean; /** * Dates to be excluded from the axis when workdaysOnly is true. */ holidays?: Array | Array; /** * Specifies chart elements to be highlighted when a user points to an axis label. */ hoverMode?: DevExpress.common.charts.ArgumentAxisHoverMode; /** * Configures the labels of the argument axis. */ label?: ArgumentAxisLabel; /** * Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number | undefined; /** * Specifies the value to be raised to a power when generating ticks for an axis of the 'logarithmic' type. */ logarithmBase?: number; /** * Specifies the minimum length of the visual range. */ minVisualRangeLength?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies how many minor ticks to place between two neighboring major ticks. */ minorTickCount?: number | undefined; /** * Specifies the interval between minor ticks. Applies only to the axes of the 'continuous' type. */ minorTickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Relocates the argument axis. */ position?: DevExpress.common.Position; /** * Specifies the position of the argument axis on the value axis. */ customPosition?: number | Date | string | undefined; /** * Specifies the name of a value axis on which the argument axis should be positioned. Applies only to multi-axis charts. */ customPositionAxis?: string | undefined; /** * Specifies the shift in pixels of the argument axis. */ offset?: number | undefined; /** * Dates to be included on the axis when workdaysOnly is true. */ singleWorkdays?: Array | Array; /** * Declares a collection of strips belonging to the argument axis. */ strips?: Array; /** * Specifies the interval between major ticks. */ tickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Configures the axis title. */ title?: ArgumentAxisTitle; /** * Specifies the type of the argument axis. */ type?: DevExpress.common.charts.AxisScaleType | undefined; /** * Defines the axis' displayed range. Cannot be wider than the wholeRange. */ visualRange?: | DevExpress.common.charts.VisualRange | Array; /** * Specifies how the axis's visual range should behave when chart data is updated. */ visualRangeUpdateMode?: DevExpress.common.charts.VisualRangeUpdateMode; /** * Defines the range where the axis can be zoomed and panned. */ wholeRange?: | DevExpress.common.charts.VisualRange | Array | undefined; /** * Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true. */ workWeek?: Array; /** * Leaves only workdays on the axis: the work week days plus single workdays minus holidays. Applies only if the axis' argumentType is 'datetime'. */ workdaysOnly?: boolean; }; /** * The type of the argumentAxisClick event handler's argument. */ export type ArgumentAxisClickEvent = DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | PointerEvent > & { /** * */ readonly argument: Date | number | string; }; /** * Declares a collection of constant lines belonging to the argument axis. */ export type ArgumentAxisConstantLines = CommonAxisSettingsConstantLineStyle & { /** * Specifies whether to display the constant line behind or in front of the series. */ displayBehindSeries?: boolean; /** * Specifies whether to extend the axis's default visual range to display the constant line. */ extendAxis?: boolean; /** * Configures the constant line label. */ label?: ArgumentAxisConstantLinesLabel; /** * Specifies the value indicated by a constant line. Setting this property is necessary. */ value?: number | Date | string | undefined; }; /** * Configures the constant line label. */ export type ArgumentAxisConstantLinesLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Aligns constant line labels in the horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Specifies the text of a constant line label. By default, equals to the value of the constant line. */ text?: string | undefined; /** * Aligns constant line labels in the vertical direction. */ verticalAlignment?: DevExpress.common.VerticalAlignment; }; /** * Specifies the appearance of those constant lines that belong to the argument axis. */ export type ArgumentAxisConstantLineStyle = CommonAxisSettingsConstantLineStyle & { /** * Specifies the appearance of the labels of those constant lines that belong to the argument axis. */ label?: ArgumentAxisConstantLineStyleLabel; }; /** * Specifies the appearance of the labels of those constant lines that belong to the argument axis. */ export type ArgumentAxisConstantLineStyleLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Aligns constant line labels in the horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Aligns constant line labels in the vertical direction. */ verticalAlignment?: DevExpress.common.VerticalAlignment; }; /** * Configures the labels of the argument axis. */ export type ArgumentAxisLabel = CommonAxisSettingsLabel & { /** * Specifies the hint that appears when a user points to an axis label. */ customizeHint?: (argument: { value?: Date | number | string; valueText?: string; }) => string; /** * Customizes the text displayed by axis labels. */ customizeText?: (argument: { value?: Date | number | string; valueText?: string; }) => string; /** * Formats a value before it is displayed in an axis label. */ format?: DevExpress.common.core.localization.Format | undefined; }; /** * Declares a collection of strips belonging to the argument axis. */ export type ArgumentAxisStrips = CommonAxisSettingsStripStyle & { /** * Specifies the color of the strip. */ color?: string | undefined; /** * Along with the startValue property, limits the strip. */ endValue?: number | Date | string | undefined; /** * Configures the strip label. */ label?: ArgumentAxisStripsLabel; /** * Along with the endValue property, limits the strip. */ startValue?: number | Date | string | undefined; }; /** * Configures the strip label. */ export type ArgumentAxisStripsLabel = CommonAxisSettingsStripStyleLabel & { /** * Specifies the text of the strip label. */ text?: string | undefined; }; /** * Configures the axis title. */ export type ArgumentAxisTitle = CommonAxisSettingsTitle & { /** * Specifies the text of the axis title. */ text?: string | undefined; }; export type ChartBubbleSeriesAggregationMethod = 'avg' | 'custom'; export type ChartFinancialSeriesAggregationMethod = 'ohlc' | 'custom'; export type ChartLabelDisplayMode = 'rotate' | 'stagger' | 'standard'; export type ChartRangeSeriesAggregationMethod = 'range' | 'custom'; export type ChartSeriesAggregationMethod = | 'avg' | 'count' | 'max' | 'min' | 'ohlc' | 'range' | 'sum' | 'custom'; export type ChartSingleValueSeriesAggregationMethod = | 'avg' | 'count' | 'max' | 'min' | 'sum' | 'custom'; export type ChartTooltipLocation = 'center' | 'edge'; export type ChartZoomAndPanMode = 'both' | 'none' | 'pan' | 'zoom'; /** * Defines common settings for both the argument and value axis in a chart. */ export type CommonAxisSettings = { /** * Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only. */ allowDecimals?: boolean | undefined; /** * Configures scale break appearance. */ breakStyle?: { /** * Specifies the scale breaks' color. */ color?: string; /** * Specifies the scale breaks' line style. */ line?: DevExpress.common.charts.ScaleBreakLineStyle; /** * Specifies the scale breaks' width in pixels. */ width?: number; }; /** * Specifies the color of the axis line. */ color?: string; /** * Configures the appearance of all constant lines in the UI component. */ constantLineStyle?: CommonAxisSettingsConstantLineStyle; /** * Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the 'discrete' type. */ discreteAxisDivisionMode?: DevExpress.common.charts.DiscreteAxisDivisionMode; /** * Specifies the start position of the aggregated series points in the aggregation interval. */ aggregatedPointsPosition?: AggregatedPointsPosition; /** * Specifies whether to force the axis to start and end on ticks. */ endOnTick?: boolean | undefined; /** * Configures the grid. */ grid?: { /** * Specifies the color of grid lines. */ color?: string; /** * Specifies how transparent grid lines should be. */ opacity?: number | undefined; /** * Makes grid lines visible. */ visible?: boolean; /** * Specifies the width of grid lines in pixels. */ width?: number; }; /** * Inverts the axis. */ inverted?: boolean; /** * Configures axis labels. */ label?: CommonAxisSettingsLabel; /** * Controls the empty space between the maximum series points and the axis. Applies only to the axes of the 'continuous' and 'logarithmic' type. */ maxValueMargin?: number | undefined; /** * Controls the empty space between the minimum series points and the axis. Applies only to the axes of the 'continuous' and 'logarithmic' type. */ minValueMargin?: number | undefined; /** * Configures the minor grid. */ minorGrid?: { /** * Specifies a color for the lines of the minor grid. */ color?: string; /** * Specifies how transparent the lines of the minor grid should be. */ opacity?: number | undefined; /** * Makes the minor grid visible. */ visible?: boolean; /** * Specifies a width for the lines of the minor grid in pixels. */ width?: number; }; /** * Configures the appearance of minor axis ticks. */ minorTick?: { /** * Specifies the color of minor ticks. */ color?: string; /** * Specifies the length of minor ticks in pixels. */ length?: number; /** * Specifies how transparent minor ticks should be. */ opacity?: number; /** * Shifts minor ticks from the reference position. */ shift?: number; /** * Makes minor ticks visible. */ visible?: boolean; /** * Specifies the width of minor ticks in pixels. */ width?: number; }; /** * Specifies how transparent the axis line should be. */ opacity?: number | undefined; /** * Reserves a pixel-measured space for the axis. */ placeholderSize?: number; /** * Configures the appearance of strips. */ stripStyle?: CommonAxisSettingsStripStyle; /** * Configures major axis tick appearance. */ tick?: { /** * Specifies the color of ticks. */ color?: string; /** * Specifies the length of ticks in pixels. */ length?: number; /** * Specifies how transparent ticks should be. */ opacity?: number | undefined; /** * Shifts ticks from the reference position. */ shift?: number; /** * Makes ticks visible. */ visible?: boolean; /** * Specifies the width of ticks in pixels. */ width?: number; }; /** * Configures axis titles. */ title?: CommonAxisSettingsTitle; /** * Adds an empty space between axis ends and minimum/maximum series points. */ valueMarginsEnabled?: boolean; /** * Makes the axis line visible. */ visible?: boolean; /** * Specifies the width of the axis line in pixels. */ width?: number; }; /** * Configures the appearance of all constant lines in the UI component. */ export type CommonAxisSettingsConstantLineStyle = { /** * Specifies the color of constant lines. */ color?: string; /** * Specifies the dash style of constant lines. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Configures constant line labels. */ label?: CommonAxisSettingsConstantLineStyleLabel; /** * Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label. */ paddingLeftRight?: number; /** * Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label. */ paddingTopBottom?: number; /** * Specifies the width of constant lines in pixels. */ width?: number; }; /** * Configures constant line labels. */ export type CommonAxisSettingsConstantLineStyleLabel = { /** * Specifies font properties for constant line labels. */ font?: DevExpress.common.charts.Font; /** * Specifies the position of constant line labels on the chart plot. */ position?: DevExpress.common.charts.RelativePosition; /** * Makes constant line labels visible. */ visible?: boolean; }; /** * Configures axis labels. */ export type CommonAxisSettingsLabel = { /** * Specifies a custom template for axis labels. */ template?: | template | (( data: object, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Aligns axis labels in relation to ticks. */ alignment?: DevExpress.common.HorizontalAlignment | undefined; /** * Allows you to rotate or stagger axis labels. Applies to the horizontal axis only. */ displayMode?: ChartLabelDisplayMode; /** * Specifies font properties for axis labels. */ font?: DevExpress.common.charts.Font; /** * Adds a pixel-measured empty space between an axis and its labels. */ indentFromAxis?: number; /** * Decides how to arrange axis labels when there is not enough space to display all of them. */ overlappingBehavior?: DevExpress.common.charts.ChartsAxisLabelOverlap; /** * Specifies the position of labels relative to the chart or its axis. */ position?: | DevExpress.common.charts.RelativePosition | DevExpress.common.Position; /** * Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is 'rotate'. */ rotationAngle?: number; /** * Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is 'stagger'. */ staggeringSpacing?: number; /** * Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Shows/hides axis labels. */ visible?: boolean; /** * Specifies how to wrap texts that do not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; }; /** * Configures the appearance of strips. */ export type CommonAxisSettingsStripStyle = { /** * Configures the appearance of strip labels. */ label?: CommonAxisSettingsStripStyleLabel; /** * Generates a pixel-measured empty space between the left/right border of a strip and the strip label. */ paddingLeftRight?: number; /** * Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label. */ paddingTopBottom?: number; }; /** * Configures the appearance of strip labels. */ export type CommonAxisSettingsStripStyleLabel = { /** * Specifies font properties for strip labels. */ font?: DevExpress.common.charts.Font; /** * Aligns strip labels in the horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Aligns strip labels in the vertical direction. */ verticalAlignment?: DevExpress.common.VerticalAlignment; }; /** * Configures axis titles. */ export type CommonAxisSettingsTitle = { /** * Aligns the axis title to the left, center, or right of the axis. */ alignment?: DevExpress.common.HorizontalAlignment; /** * Specifies font properties for the axis title. */ font?: DevExpress.common.charts.Font; /** * Adds a pixel-measured empty space between the axis title and axis labels. */ margin?: number; /** * Specifies what to do with the axis title when it overflows the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Specifies how to wrap the axis title if it does not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; }; /** * Defines common settings for all panes in a chart. */ export type CommonPaneSettings = { /** * Specifies the color of the pane's background. */ backgroundColor?: string | DevExpress.common.charts.ChartsColor; /** * Configures the pane border. */ border?: { /** * Shows/hides the bottom border of the pane. Applies only when the border.visible property is true. */ bottom?: boolean; /** * Specifies the color of the pane border. */ color?: string; /** * Specifies the dash style of the pane border. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Shows/hides the left border of the pane. Applies only when the border.visible property is true. */ left?: boolean; /** * Specifies how transparent the pane border should be. */ opacity?: number | undefined; /** * Shows/hides the right border of the pane. Applies only when the border.visible property is true. */ right?: boolean; /** * Shows/hides the top border of the pane. Applies only when the border.visible property is true. */ top?: boolean; /** * Shows the pane border. */ visible?: boolean; /** * Specifies the width of the pane border in pixels. */ width?: number; }; }; /** * Specifies settings common for all series in the chart. */ export type CommonSeriesSettings = dxChartSeriesTypesCommonSeries & { /** * Defines common settings for all area series. */ area?: any; /** * Defines common settings for all bar series. */ bar?: any; /** * Defines common settings for all bubble series. */ bubble?: any; /** * Defines common settings for all candlestick series. */ candlestick?: any; /** * Defines common settings for all full-stacked area series. */ fullstackedarea?: any; /** * Defines common settings for all full-stacked bar series. */ fullstackedbar?: any; /** * Defines common settings for all full-stacked line series. */ fullstackedline?: any; /** * Defines common settings for all full-stacked spline series. */ fullstackedspline?: any; /** * Defines common settings for all full-stacked spline area series. */ fullstackedsplinearea?: any; /** * Defines common settings for all line series. */ line?: any; /** * Defines common settings for all range area series. */ rangearea?: any; /** * Defines common settings for all range bar series. */ rangebar?: any; /** * Defines common settings for all scatter series. */ scatter?: any; /** * Defines common settings for all spline series. */ spline?: any; /** * Defines common settings for all spline area series. */ splinearea?: any; /** * Defines common settings for all stacked area series. */ stackedarea?: any; /** * Defines common settings for all stacked bar series. */ stackedbar?: any; /** * Defines common settings for all stacked line series. */ stackedline?: any; /** * Defines common settings for all stacked spline series. */ stackedspline?: any; /** * Defines common settings for all stacked spline area series. */ stackedsplinearea?: any; /** * Defines common settings for all step area series. */ steparea?: any; /** * Defines common settings for all step line series. */ stepline?: any; /** * Defines common settings for all stock series. */ stock?: any; /** * Specifies the type of the series. */ type?: DevExpress.common.charts.SeriesType; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the done event handler's argument. */ export type DoneEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * @deprecated Use CommonSeriesSettings instead * @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 dxChartCommonSeriesSettings = CommonSeriesSettings; export type EventKeyModifier = 'alt' | 'ctrl' | 'meta' | 'shift'; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; export type FinancialChartReductionLevel = | 'close' | 'high' | 'low' | 'open'; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * Specifies the properties of a chart's legend. */ export type Legend = BaseChartLegend & { /** * Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ customizeHint?: (seriesInfo: { seriesName?: any; seriesIndex?: number; seriesColor?: string; }) => string; /** * Specifies a callback function that returns the text to be displayed by a legend item. */ customizeText?: (seriesInfo: { seriesName?: any; seriesIndex?: number; seriesColor?: string; }) => string; /** * Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ hoverMode?: DevExpress.common.charts.LegendHoverMode; /** * Specifies whether the legend is located outside or inside the chart's plot. */ position?: DevExpress.common.charts.RelativePosition; }; /** * The type of the legendClick event handler's argument. */ export type LegendClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | PointerEvent > & { /** * */ readonly target: chartSeriesObject; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * Declares a collection of panes. */ export type Panes = CommonPaneSettings & { /** * Specifies the pane's height (or width when the chart is rotated) in a multi-pane chart. */ height?: number | string | undefined; /** * Specifies the name of the pane. */ name?: string | undefined; }; /** * The type of the pointClick event handler's argument. */ export type PointClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | PointerEvent > & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointHoverChanged event handler's argument. */ export type PointHoverChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointSelectionChanged event handler's argument. */ export type PointSelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; export type Properties = dxChartOptions; /** * The type of the seriesClick event handler's argument. */ export type SeriesClickEvent = DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | PointerEvent > & { /** * */ readonly target: chartSeriesObject; }; /** * The type of the seriesHoverChanged event handler's argument. */ export type SeriesHoverChangedEvent = DevExpress.common.core.events.EventInfo & SeriesInteractionInfo; /** * * @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 SeriesInteractionInfo { /** * */ target: chartSeriesObject; } /** * The type of the seriesSelectionChanged event handler's argument. */ export type SeriesSelectionChangedEvent = DevExpress.common.core.events.EventInfo & SeriesInteractionInfo; /** * * @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 Tooltip = BaseChartTooltip & { /** * Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only. */ location?: ChartTooltipLocation; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; /** * Configures the value axis. */ export type ValueAxis = CommonAxisSettings & { /** * Enables auto-calculated scale breaks. Applies only if the axis' type is 'continuous' or 'logarithmic' and valueType is 'numeric'. */ autoBreaksEnabled?: boolean; /** * Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the 'continuous' and 'logarithmic' types. */ axisDivisionFactor?: number; /** * Declares a custom scale break collection. Applies only if the axis' type is 'continuous' or 'logarithmic'. */ breaks?: Array; /** * Specifies the order of categories on an axis of the 'discrete' type. */ categories?: Array; /** * Specifies the appearance of those constant lines that belong to the value axis. */ constantLineStyle?: ValueAxisConstantLineStyle; /** * Declares a collection of constant lines belonging to the value axis. */ constantLines?: Array; /** * Specifies whether to force the axis to start and end on ticks. */ endOnTick?: boolean | undefined; /** * Configures the labels of the value axis. */ label?: ValueAxisLabel; /** * Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number | undefined; /** * Specifies the value to be raised to a power when generating ticks for an axis of the 'logarithmic' type. */ logarithmBase?: number; /** * Sets a limit on auto-calculated scale breaks. Custom scale breaks are not counted. */ maxAutoBreakCount?: number; /** * Specifies the minimum length of the visual range. */ minVisualRangeLength?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies how many minor ticks to place between two neighboring major ticks. */ minorTickCount?: number | undefined; /** * Specifies the interval between minor ticks. Applies only to continuous axes. */ minorTickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart. */ multipleAxesSpacing?: number; /** * Specifies the name of the value axis. */ name?: string | undefined; /** * Binds the value axis to a pane. */ pane?: string | undefined; /** * Relocates the value axis. */ position?: DevExpress.common.Position; /** * Specifies the position of the value axis on the argument axis. */ customPosition?: number | Date | string | undefined; /** * Specifies the shift in pixels of the value axis. */ offset?: number | undefined; /** * Specifies whether or not to show zero on the value axis. */ showZero?: boolean | undefined; /** * Declares a collection of strips belonging to the value axis. */ strips?: Array; /** * Synchronizes two or more value axes with each other at a specific value. */ synchronizedValue?: number | undefined; /** * Specifies the interval between major ticks. Does not apply to discrete axes. */ tickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Configures the axis title. */ title?: ValueAxisTitle; /** * Specifies the type of the value axis. */ type?: DevExpress.common.charts.AxisScaleType | undefined; /** * Casts values to a specified data type. */ valueType?: DevExpress.common.charts.ChartsDataType | undefined; /** * Defines the axis' displayed range. Cannot be wider than the wholeRange. */ visualRange?: | DevExpress.common.charts.VisualRange | Array; /** * Specifies how the axis's visual range should behave when chart data is updated. */ visualRangeUpdateMode?: DevExpress.common.charts.ValueAxisVisualRangeUpdateMode; /** * Defines the range where the axis can be zoomed and panned. */ wholeRange?: | DevExpress.common.charts.VisualRange | Array | undefined; }; /** * Declares a collection of constant lines belonging to the value axis. */ export type ValueAxisConstantLines = CommonAxisSettingsConstantLineStyle & { /** * Specifies whether to display the constant line behind or in front of the series. */ displayBehindSeries?: boolean; /** * Specifies whether to extend the axis's default visual range to display the constant line. */ extendAxis?: boolean; /** * Configures the constant line label. */ label?: ValueAxisConstantLinesLabel; /** * Specifies the value indicated by a constant line. Setting this property is necessary. */ value?: number | Date | string | undefined; }; /** * Configures the constant line label. */ export type ValueAxisConstantLinesLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Aligns constant line labels in the horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Specifies the text of a constant line label. By default, equals to the value of the constant line. */ text?: string | undefined; /** * Aligns constant line labels in the vertical direction. */ verticalAlignment?: DevExpress.common.VerticalAlignment; }; /** * Specifies the appearance of those constant lines that belong to the value axis. */ export type ValueAxisConstantLineStyle = CommonAxisSettingsConstantLineStyle & { /** * Specifies the appearance of the labels of those constant lines that belong to the value axis. */ label?: ValueAxisConstantLineStyleLabel; }; /** * Specifies the appearance of the labels of those constant lines that belong to the value axis. */ export type ValueAxisConstantLineStyleLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Aligns constant line labels in the horizontal direction. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Aligns constant line labels in the vertical direction. */ verticalAlignment?: DevExpress.common.VerticalAlignment; }; /** * Configures the labels of the value axis. */ export type ValueAxisLabel = CommonAxisSettingsLabel & { /** * Specifies the hint that appears when a user points to an axis label. */ customizeHint?: (axisValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Customizes the text displayed by axis labels. */ customizeText?: (axisValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Formats a value before it is displayed in an axis label. */ format?: DevExpress.common.core.localization.Format | undefined; }; /** * Declares a collection of strips belonging to the value axis. */ export type ValueAxisStrips = CommonAxisSettingsStripStyle & { /** * Specifies the color of the strip. */ color?: string | undefined; /** * Along with the startValue property, limits the strip. */ endValue?: number | Date | string | undefined; /** * Configures the strip label. */ label?: ValueAxisStripsLabel; /** * Along with the endValue property, limits the strip. */ startValue?: number | Date | string | undefined; }; /** * Configures the strip label. */ export type ValueAxisStripsLabel = CommonAxisSettingsStripStyleLabel & { /** * Specifies the text of the strip label. */ text?: string | undefined; }; /** * Configures the axis title. */ export type ValueAxisTitle = CommonAxisSettingsTitle & { /** * Specifies the text of the axis title. */ text?: string | undefined; }; /** * The type of the zoomEnd event handler's argument. */ export type ZoomEndEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | TouchEvent > & { /** * */ readonly rangeStart: Date | number; /** * */ readonly rangeEnd: Date | number; /** * */ readonly axis: chartAxisObject; /** * */ readonly range: DevExpress.common.charts.VisualRange; /** * */ readonly previousRange: DevExpress.common.charts.VisualRange; /** * */ readonly actionType: DevExpress.common.charts.ZoomPanAction; /** * */ readonly zoomFactor: number; /** * */ readonly shift: number; }; /** * The type of the zoomStart event handler's argument. */ export type ZoomStartEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxChart, MouseEvent | TouchEvent > & { /** * */ readonly axis: chartAxisObject; /** * */ readonly range: DevExpress.common.charts.VisualRange; /** * */ readonly actionType?: DevExpress.common.charts.ZoomPanAction; }; } /** * * @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 dxChartAnnotationConfig extends dxChartCommonAnnotationConfig { /** * Specifies the annotation's name. */ name?: string | undefined; } /** * * @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 dxChartCommonAnnotationConfig extends BaseChartAnnotationConfig { /** * Specifies the name of the value axis on which the value is specified. Useful for a multi-axis chart. */ axis?: string | undefined; /** * Customizes the text and appearance of the annotation's tooltip. */ customizeTooltip?: | ((annotation: dxChartAnnotationConfig | any) => any) | undefined; /** * Specifies a custom template for the annotation. Applies only if the type is 'custom'. */ template?: | template | (( annotation: dxChartAnnotationConfig | any, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies a custom template for an annotation's tooltip. */ tooltipTemplate?: | template | (( annotation: dxChartAnnotationConfig | any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; } /** * * @deprecated * @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 dxChartOptions extends BaseChartOptions { /** * Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned. */ adjustOnZoom?: boolean; /** * Specifies the annotation collection. */ annotations?: Array; /** * Configures the argument axis. */ argumentAxis?: DevExpress.viz.dxChart.ArgumentAxis; /** * Specifies whether to hide series point markers automatically to reduce visual clutter. */ autoHidePointMarkers?: boolean; /** * Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. */ barGroupPadding?: number; /** * Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property. */ barGroupWidth?: number | undefined; /** * Specifies settings common for all annotations in the chart. */ commonAnnotationSettings?: dxChartCommonAnnotationConfig; /** * Defines common settings for both the argument and value axis in a chart. */ commonAxisSettings?: DevExpress.viz.dxChart.CommonAxisSettings; /** * Defines common settings for all panes in a chart. */ commonPaneSettings?: DevExpress.viz.dxChart.CommonPaneSettings; /** * Specifies settings common for all series in the chart. */ commonSeriesSettings?: DevExpress.viz.dxChart.CommonSeriesSettings; /** * Specifies background color of the chart container. */ containerBackgroundColor?: string; /** * Configures the crosshair feature. */ crosshair?: { /** * Specifies the color of the crosshair lines. */ color?: string; /** * Specifies the dash style of the crosshair lines. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Enables the crosshair. */ enabled?: boolean; /** * Configures the horizontal crosshair line individually. */ horizontalLine?: | { /** * Specifies the color of the horizontal crosshair line. */ color?: string; /** * Specifies the dash style of the horizontal crosshair line. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Configures the label that belongs to the horizontal crosshair line. */ label?: { /** * Paints the background of the label that belongs to the horizontal crosshair line. */ backgroundColor?: string; /** * Customizes the text displayed by the label that belongs to the horizontal crosshair line. */ customizeText?: (info: { value?: Date | number | string; valueText?: string; point?: chartPointObject; }) => string; /** * Specifies font properties for the label of the horizontal crosshair line. */ font?: DevExpress.common.charts.Font; /** * Formats a point value before it is displayed in the crosshair label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Makes the label of the horizontal crosshair line visible. Applies only if the crosshair feature is enabled and the horizontal line is visible. */ visible?: boolean; }; /** * Specifies how transparent the horizontal crosshair line should be. */ opacity?: number | undefined; /** * Specifies whether to show the horizontal crosshair line or not. */ visible?: boolean; /** * Specifies the width of the horizontal crosshair line in pixels. */ width?: number; } | boolean; /** * Configures the crosshair labels. */ label?: { /** * Paints the background of the crosshair labels. */ backgroundColor?: string; /** * Customizes the text displayed by the crosshair labels. */ customizeText?: (info: { value?: Date | number | string; valueText?: string; point?: chartPointObject; }) => string; /** * Specifies font properties for the crosshair labels. */ font?: DevExpress.common.charts.Font; /** * Formats a point value/argument before it is displayed in the crosshair label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Makes the crosshair labels visible. Applies only if the crosshair feature is enabled. */ visible?: boolean; }; /** * Specifies how transparent the crosshair lines should be. */ opacity?: number | undefined; /** * Configures the vertical crosshair line individually. */ verticalLine?: | { /** * Specifies the color of the vertical crosshair line. */ color?: string; /** * Specifies the dash style of the vertical crosshair line. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Configures the label that belongs to the vertical crosshair line. */ label?: { /** * Paints the background of the label that belongs to the vertical crosshair line. */ backgroundColor?: string; /** * Customizes the text displayed by the label that belongs to the vertical crosshair line. */ customizeText?: (info: { value?: Date | number | string; valueText?: string; point?: chartPointObject; }) => string; /** * Specifies font properties for the label of the vertical crosshair line. */ font?: DevExpress.common.charts.Font; /** * Formats the point argument before it is displayed in the crosshair label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Makes the label of the vertical crosshair line visible. Applies only if the crosshair feature is enabled and the vertical line is visible. */ visible?: boolean; }; /** * Specifies how transparent the vertical crosshair line should be. */ opacity?: number | undefined; /** * Specifies whether to show the vertical crosshair line or not. */ visible?: boolean; /** * Specifies the width of the vertical crosshair line in pixels. */ width?: number; } | boolean; /** * Specifies the width of the crosshair lines. */ width?: number; }; /** * Customizes an individual annotation. */ customizeAnnotation?: | ((annotation: dxChartAnnotationConfig | any) => dxChartAnnotationConfig) | undefined; /** * Processes data before visualizing it. */ dataPrepareSettings?: { /** * Validates the type of each value coming from the data source. */ checkTypeForAllData?: boolean; /** * Converts data coming from a data source into a data type supported by the axis. */ convertToAxisDataType?: boolean; /** * Specifies the sorting order in which series points should be drawn. */ sortingMethod?: boolean | ((a: any, b: any) => number); }; /** * Specifies which pane should be used by default. */ defaultPane?: string | undefined; /** * Specifies the properties of a chart's legend. */ legend?: DevExpress.viz.dxChart.Legend; /** * Specifies a coefficient determining the diameter of the largest bubble. */ maxBubbleSize?: number; /** * Specifies the diameter of the smallest bubble measured in pixels. */ minBubbleSize?: number; /** * Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. */ negativesAsZeroes?: boolean; /** * A function that is executed when a label on the argument axis is clicked or tapped. */ onArgumentAxisClick?: | ((e: DevExpress.viz.dxChart.ArgumentAxisClickEvent) => void) | string; /** * A function that is executed when a legend item is clicked or tapped. */ onLegendClick?: | ((e: DevExpress.viz.dxChart.LegendClickEvent) => void) | string; /** * A function that is executed when a series is clicked or tapped. */ onSeriesClick?: | ((e: DevExpress.viz.dxChart.SeriesClickEvent) => void) | string; /** * A function that is executed after the pointer enters or leaves a series. */ onSeriesHoverChanged?: ( e: DevExpress.viz.dxChart.SeriesHoverChangedEvent ) => void; /** * A function that is executed when a series is selected or selection is canceled. */ onSeriesSelectionChanged?: ( e: DevExpress.viz.dxChart.SeriesSelectionChangedEvent ) => void; /** * A function that is executed when zooming or panning ends. */ onZoomEnd?: (e: DevExpress.viz.dxChart.ZoomEndEvent) => void; /** * A function that is executed when zooming or panning begins. */ onZoomStart?: (e: DevExpress.viz.dxChart.ZoomStartEvent) => void; /** * Declares a collection of panes. */ panes?: DevExpress.viz.dxChart.Panes | Array; /** * Specifies whether panes can be resized if other chart elements require more space after zooming or panning. */ resizePanesOnZoom?: boolean; /** * Specifies how the chart must behave when series point labels overlap. */ resolveLabelOverlapping?: DevExpress.common.charts.ChartsLabelOverlap; /** * Swaps the axes around making the value axis horizontal and the argument axis vertical. */ rotated?: boolean; /** * Specifies the settings of the scroll bar. */ scrollBar?: { /** * Specifies the color of the scroll bar. */ color?: string; /** * Specifies the spacing between the scroll bar and the chart's plot in pixels. */ offset?: number; /** * Specifies the opacity of the scroll bar. */ opacity?: number | undefined; /** * Specifies the position of the scroll bar in the chart. */ position?: DevExpress.common.Position; /** * Specifies whether the scroll bar is visible or not. */ visible?: boolean; /** * Specifies the width of the scroll bar in pixels. */ width?: number; }; /** * Specifies properties for Chart UI component series. */ series?: ChartSeries | Array | undefined; /** * Specifies whether a single series or multiple series can be selected in the chart. */ seriesSelectionMode?: DevExpress.common.SingleOrMultiple; /** * Defines properties for the series template. */ seriesTemplate?: { /** * Specifies a callback function that returns a series object with individual series settings. */ customizeSeries?: (seriesName: any) => ChartSeries; /** * Specifies a data source field that represents the series name. */ nameField?: string; }; /** * Specifies whether a point should remain in the hover state when the mouse pointer moves away. */ stickyHovering?: boolean; /** * Indicates whether or not to synchronize value axes when they are displayed on a single pane. */ synchronizeMultiAxes?: boolean; /** * Configures tooltips. */ tooltip?: DevExpress.viz.dxChart.Tooltip; /** * Configures the value axis. */ valueAxis?: | DevExpress.viz.dxChart.ValueAxis | Array; /** * Configures zooming and panning. */ zoomAndPan?: { /** * Specifies whether users can use the mouse wheel to zoom the chart. Applies only if zoom is allowed for the argument or value axis. */ allowMouseWheel?: boolean; /** * Specifies whether users can use touch gestures to zoom or pan the chart. Applies only if zoom and pan are allowed for the argument or value axis. */ allowTouchGestures?: boolean; /** * Specifies whether users are allowed to zoom and/or pan the argument axis. */ argumentAxis?: DevExpress.viz.dxChart.ChartZoomAndPanMode; /** * Configures the box that appears when users zoom the chart by selecting an area with the drag gesture. Applies only if dragToZoom is true. */ dragBoxStyle?: { /** * Specifies the drag box's color. */ color?: string | undefined; /** * Specifies the drag box's transparency. */ opacity?: number | undefined; }; /** * Enables users to zoom the chart by selecting an area with the drag gesture. Applies only on devices that use a mouse. */ dragToZoom?: boolean; /** * Specifies the key that enables panning when dragToZoom is true. Applies only on devices that use a mouse. */ panKey?: DevExpress.viz.dxChart.EventKeyModifier; /** * Specifies whether users are allowed to zoom and/or pan the value axis. */ valueAxis?: DevExpress.viz.dxChart.ChartZoomAndPanMode; }; } /** * This section lists objects that define properties used to configure series of specific types. * @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 dxChartSeriesTypes { /** * Describes settings supported by a series of the area type. */ AreaSeries?: dxChartSeriesTypesAreaSeries; /** * Describes settings supported by a series of the bar type. */ BarSeries?: dxChartSeriesTypesBarSeries; /** * Describes settings supported by a series of the bubble type. */ BubbleSeries?: dxChartSeriesTypesBubbleSeries; /** * Describes settings supported by a series of the candlestick type. */ CandleStickSeries?: dxChartSeriesTypesCandleStickSeries; /** * An object that defines configuration properties for chart series. */ CommonSeries?: dxChartSeriesTypesCommonSeries; /** * Describes settings supported by a series of the full-stacked area type. */ FullStackedAreaSeries?: dxChartSeriesTypesFullStackedAreaSeries; /** * Describes settings supported by a series of the full-stacked bar type. */ FullStackedBarSeries?: dxChartSeriesTypesFullStackedBarSeries; /** * Describes settings supported by a series of the full-stacked line type. */ FullStackedLineSeries?: dxChartSeriesTypesFullStackedLineSeries; /** * Describes settings supported by a series of the full-stacked spline area type. */ FullStackedSplineAreaSeries?: dxChartSeriesTypesFullStackedSplineAreaSeries; /** * Describes settings supported by a series of the full-stacked spline area type. An object defining a series of the fullStackedSpline type. */ FullStackedSplineSeries?: dxChartSeriesTypesFullStackedSplineSeries; /** * Describes settings supported by a series of the line type. */ LineSeries?: dxChartSeriesTypesLineSeries; /** * Describes settings supported by a series of the range area type. */ RangeAreaSeries?: dxChartSeriesTypesRangeAreaSeries; /** * Describes settings supported by a series of the range bar type. */ RangeBarSeries?: dxChartSeriesTypesRangeBarSeries; /** * Describes settings supported by a series of the scatter type. */ ScatterSeries?: dxChartSeriesTypesScatterSeries; /** * Describes settings supported by a series of the spline area type. */ SplineAreaSeries?: dxChartSeriesTypesSplineAreaSeries; /** * Describes settings supported by a series of the spline type. */ SplineSeries?: dxChartSeriesTypesSplineSeries; /** * Describes settings supported by a series of the stacked area type. */ StackedAreaSeries?: dxChartSeriesTypesStackedAreaSeries; /** * Describes settings supported by a series of the stacked bar type. */ StackedBarSeries?: dxChartSeriesTypesStackedBarSeries; /** * Describes settings supported by a series of the stacked line type. */ StackedLineSeries?: dxChartSeriesTypesStackedLineSeries; /** * Describes settings supported by a series of the stacked spline area type. */ StackedSplineAreaSeries?: dxChartSeriesTypesStackedSplineAreaSeries; /** * Describes settings supported by a series of the stacked spline type. */ StackedSplineSeries?: dxChartSeriesTypesStackedSplineSeries; /** * Describes settings supported by a series of the step rea type. */ StepAreaSeries?: dxChartSeriesTypesStepAreaSeries; /** * Describes settings supported by a series of the step line type. */ StepLineSeries?: dxChartSeriesTypesStepLineSeries; /** * Describes settings supported by a series of the stock type. */ StockSeries?: dxChartSeriesTypesStockSeries; } /** * @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 dxChartSeriesTypesAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesBarSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesBarSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesBarSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a bar. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesBarSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesBarSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesBubbleSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesBubbleSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesBubbleSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a bubble. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesBubbleSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartBubbleSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesBubbleSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesCandleStickSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesCandleStickSeriesAggregation; /** * Specifies which data source field provides arguments for series points. */ argumentField?: string; /** * Specifies series elements to be highlighted when a user pauses on a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures the appearance adopted by the series when a user points to it. */ hoverStyle?: dxChartSeriesTypesCandleStickSeriesHoverStyle; /** * Configures point labels. */ label?: dxChartSeriesTypesCandleStickSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a point. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures the appearance adopted by the series when a user selects it. */ selectionStyle?: dxChartSeriesTypesCandleStickSeriesSelectionStyle; } /** * @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 dxChartSeriesTypesCandleStickSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartFinancialSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesCandleStickSeriesHoverStyle extends dxChartSeriesTypesCommonSeriesHoverStyle { /** * Configures hatching that applies when a user points to the series. */ hatching?: dxChartSeriesTypesCandleStickSeriesHoverStyleHatching; } /** * @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 dxChartSeriesTypesCandleStickSeriesHoverStyleHatching extends dxChartSeriesTypesCommonSeriesHoverStyleHatching { /** * Specifies the direction of hatching lines. */ direction?: DevExpress.common.charts.HatchDirection; } /** * @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 dxChartSeriesTypesCandleStickSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesCandleStickSeriesSelectionStyle extends dxChartSeriesTypesCommonSeriesSelectionStyle { /** * Configures hatching that applies when a user selects the series. */ hatching?: dxChartSeriesTypesCandleStickSeriesSelectionStyleHatching; } /** * @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 dxChartSeriesTypesCandleStickSeriesSelectionStyleHatching extends dxChartSeriesTypesCommonSeriesSelectionStyleHatching { /** * Specifies the direction of hatching lines. */ direction?: DevExpress.common.charts.HatchDirection; } /** * @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 dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesCommonSeriesAggregation; /** * Specifies which data source field provides arguments for series points. */ argumentField?: string; /** * Binds the series to a value axis. */ axis?: string | undefined; /** * Allows you to group bar series so that bars with the same argument overlap. */ barOverlapGroup?: string | undefined; /** * Controls the padding and consequently the width of all bars in a series using relative units. Ignored if the barWidth property is set. */ barPadding?: number | undefined; /** * Specifies a fixed width for all bars in a series, measured in pixels. Takes precedence over the barPadding property. */ barWidth?: number | undefined; /** * Configures the series border (in area-like series) or the series point border (in bar-like and bubble series). */ border?: dxChartSeriesTypesCommonSeriesBorder; /** * Specifies which data source field provides close values for points of a financial series. */ closeValueField?: string; /** * Specifies the color of the series. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Makes bars look rounded. Applies only to bar-like series. */ cornerRadius?: number; /** * Specifies the dash style of the series line. Applies only to line-like series. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies which data source field provides high values for points of a financial series. */ highValueField?: string; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: DevExpress.common.charts.SeriesHoverMode; /** * Configures the appearance adopted by the series when a user points to it. */ hoverStyle?: dxChartSeriesTypesCommonSeriesHoverStyle; /** * Specifies whether the series should ignore empty data points. */ ignoreEmptyPoints?: boolean; /** * Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series. */ innerColor?: string; /** * Configures point labels. */ label?: DevExpress.common.charts.SeriesLabel; /** * Specifies which data source field provides low values for points of a financial series. */ lowValueField?: string; /** * Specifies a limit for the number of point labels. */ maxLabelCount?: number | undefined; /** * Specifies the minimal possible height (or length if the chart is rotated) of a bar in pixels. Applies only to bar-like series. */ minBarSize?: number | undefined; /** * Specifies how transparent the series should be. */ opacity?: number; /** * Specifies which data source field provides open values for points of a financial series. */ openValueField?: string; /** * Specifies which pane the series should belong to. Accepts the name of the pane. */ pane?: string; /** * Configures series points in scatter, line- and area-like series. */ point?: DevExpress.common.charts.SeriesPoint; /** * Coupled with the rangeValue2Field property, specifies which data source field provides values for a range-like series. */ rangeValue1Field?: string; /** * Coupled with the rangeValue1Field property, specifies which data source field provides values for a range-like series. */ rangeValue2Field?: string; /** * Specifies reduction properties for financial series. */ reduction?: { /** * Specifies a color for the points whose price has decreased in comparison to the price of the previous point. */ color?: string; /** * Specifies whether high, low, open or close prices of points should be compared. */ level?: DevExpress.viz.dxChart.FinancialChartReductionLevel; }; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: DevExpress.common.charts.SeriesSelectionMode; /** * Configures the appearance adopted by the series when a user selects it. */ selectionStyle?: dxChartSeriesTypesCommonSeriesSelectionStyle; /** * Specifies whether to show the series in the legend or not. */ showInLegend?: boolean; /** * Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series. */ sizeField?: string; /** * Specifies which stack the series should belongs to. Applies only to stacked bar and full-stacked bar series. */ stack?: string; /** * Specifies which data source field provides auxiliary data for series points. */ tagField?: string; /** * Configures error bars. */ valueErrorBar?: { /** * Specifies the color of error bars. */ color?: string; /** * Specifies whether error bars must be displayed in full or partially. */ displayMode?: DevExpress.common.charts.ValueErrorBarDisplayMode; /** * Specifies the length of the lines that indicate error bar edges. */ edgeLength?: number; /** * Specifies which data field provides high error values. */ highValueField?: string | undefined; /** * Specifies the width of the error bar line. */ lineWidth?: number; /** * Specifies which data field provides low error values. */ lowValueField?: string | undefined; /** * Specifies how trasparent error bars should be. */ opacity?: number | undefined; /** * Specifies how error bar values must be calculated. */ type?: DevExpress.common.charts.ValueErrorBarType | undefined; /** * Specifies the value to be used for generating error bars. */ value?: number; }; /** * Specifies which data source field provides values for series points. */ valueField?: string; /** * Specifies whether the series is visible or not. */ visible?: boolean; /** * Specifies the width of the series line in pixels. Applies only to line-like series. */ width?: number; } /** * @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 dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies a custom aggregate function. Applies only if the aggregation method is 'custom'. */ calculate?: | (( aggregationInfo: chartPointAggregationInfoObject, series: chartSeriesObject ) => any | Array) | undefined; /** * Enables data aggregation for the series. */ enabled?: boolean; /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesCommonSeriesBorder { /** * Colors the series border (in area-like series) or the series point border (in bar-like and bubble series). */ color?: string | undefined; /** * Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series). */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series). */ visible?: boolean; /** * Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series). */ width?: number; } /** * @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 dxChartSeriesTypesCommonSeriesHoverStyle { /** * Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series. */ border?: dxChartSeriesTypesCommonSeriesHoverStyleBorder; /** * Specifies the color of the series in the hovered state. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the dash style of the series line when the series is in the hovered state. Applies only to line-like series. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Configures hatching that applies when a user points to the series. */ hatching?: dxChartSeriesTypesCommonSeriesHoverStyleHatching; /** * Specifies the pixel-measured width of the series line when the series is in the hovered state. */ width?: number; /** * Specifies whether to lighten the series when a user hovers the mouse pointer over it. */ highlight?: 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 interface dxChartSeriesTypesCommonSeriesHoverStyleBorder { /** * Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series. */ color?: string | undefined; /** * Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series. */ visible?: boolean; /** * Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series. */ width?: number; } /** * @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 dxChartSeriesTypesCommonSeriesHoverStyleHatching { /** * Specifies the direction of hatching lines. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies how transparent hatching lines should be. */ opacity?: number; /** * Specifies the distance between two side-by-side hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; } /** * @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 dxChartSeriesTypesCommonSeriesSelectionStyle { /** * Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series. */ border?: dxChartSeriesTypesCommonSeriesSelectionStyleBorder; /** * Specifies the color of the series in the selected state. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the dash style of the series line when the series is in the selected state. Applies only to line-like series. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Configures hatching that applies when a user selects the series. */ hatching?: dxChartSeriesTypesCommonSeriesSelectionStyleHatching; /** * Specifies the pixel-measured width of the series line when the series is in the selected state. */ width?: number; /** * Specifies whether to lighten the series when a user selects it. */ highlight?: 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 interface dxChartSeriesTypesCommonSeriesSelectionStyleBorder { /** * Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series. */ color?: string | undefined; /** * Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series. */ visible?: boolean; /** * Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series. */ width?: number; } /** * @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 dxChartSeriesTypesCommonSeriesSelectionStyleHatching { /** * Specifies the direction of hatching lines. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies how transparent hatching lines should be. */ opacity?: number; /** * Specifies the distance between two side-by-side hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; } /** * @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 dxChartSeriesTypesFullStackedAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesFullStackedAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * An object defining the label configuration properties. */ label?: dxChartSeriesTypesFullStackedAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesFullStackedAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesFullStackedAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesFullStackedAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesFullStackedAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesFullStackedBarSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesFullStackedBarSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesFullStackedBarSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a bar. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesFullStackedBarSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesFullStackedBarSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => string; /** * Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series. */ position?: DevExpress.common.charts.RelativePosition; } /** * @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 dxChartSeriesTypesFullStackedLineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesFullStackedLineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesFullStackedLineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesFullStackedLineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesFullStackedLineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesFullStackedSplineAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesFullStackedSplineAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesFullStackedSplineAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesFullStackedSplineAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesFullStackedSplineAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesFullStackedSplineAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesFullStackedSplineAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesFullStackedSplineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesFullStackedSplineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesFullStackedSplineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesFullStackedSplineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesFullStackedSplineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesLineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesLineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesLineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesLineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesLineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesRangeAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesRangeAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesRangeAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesRangeAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesRangeAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartRangeSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesRangeAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesRangeAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesRangeBarSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesRangeBarSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesRangeBarSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a range bar. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesRangeBarSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartRangeSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesRangeBarSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesScatterSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesScatterSeriesAggregation; /** * Configures point labels. */ label?: dxChartSeriesTypesScatterSeriesLabel; } /** * @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 dxChartSeriesTypesScatterSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesScatterSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesSplineAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesSplineAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesSplineAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesSplineAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesSplineAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesSplineAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesSplineAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesSplineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesSplineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesSplineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesSplineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesSplineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStackedAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStackedAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStackedAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesStackedAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesStackedAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStackedAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStackedAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesStackedBarSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStackedBarSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStackedBarSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a bar. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesStackedBarSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStackedBarSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => string; /** * Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series. */ position?: DevExpress.common.charts.RelativePosition; } /** * @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 dxChartSeriesTypesStackedLineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStackedLineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStackedLineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesStackedLineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStackedLineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStackedSplineAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStackedSplineAreaSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStackedSplineAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesStackedSplineAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesStackedSplineAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStackedSplineAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStackedSplineAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesStackedSplineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStackedSplineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStackedSplineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesStackedSplineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStackedSplineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStepAreaSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStepAreaSeriesAggregation; /** * Configures the series border (in area-like series) or the series point border (in bar-like and bubble series). */ border?: dxChartSeriesTypesStepAreaSeriesBorder; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures the appearance adopted by the series when a user points to it. */ hoverStyle?: dxChartSeriesTypesStepAreaSeriesHoverStyle; /** * Configures point labels. */ label?: dxChartSeriesTypesStepAreaSeriesLabel; /** * Configures series points in scatter, line- and area-like series. */ point?: dxChartSeriesTypesStepAreaSeriesPoint; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; /** * Configures the appearance adopted by the series when a user selects it. */ selectionStyle?: dxChartSeriesTypesStepAreaSeriesSelectionStyle; } /** * @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 dxChartSeriesTypesStepAreaSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStepAreaSeriesBorder extends dxChartSeriesTypesCommonSeriesBorder { /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series). */ visible?: 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 interface dxChartSeriesTypesStepAreaSeriesHoverStyle extends dxChartSeriesTypesCommonSeriesHoverStyle { /** * Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series. */ border?: dxChartSeriesTypesStepAreaSeriesHoverStyleBorder; } /** * @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 dxChartSeriesTypesStepAreaSeriesHoverStyleBorder extends dxChartSeriesTypesCommonSeriesHoverStyleBorder { /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series. */ visible?: 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 interface dxChartSeriesTypesStepAreaSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStepAreaSeriesPoint extends DevExpress.common.charts.SeriesPoint { /** * Makes the series points visible. */ visible?: 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 interface dxChartSeriesTypesStepAreaSeriesSelectionStyle extends dxChartSeriesTypesCommonSeriesSelectionStyle { /** * Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series. */ border?: dxChartSeriesTypesStepAreaSeriesSelectionStyleBorder; } /** * @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 dxChartSeriesTypesStepAreaSeriesSelectionStyleBorder extends dxChartSeriesTypesCommonSeriesSelectionStyleBorder { /** * Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series. */ visible?: 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 interface dxChartSeriesTypesStepLineSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStepLineSeriesAggregation; /** * Specifies series elements to be highlighted when a user points to a series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStepLineSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxChartSeriesTypesStepLineSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartSingleValueSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStepLineSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => 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 interface dxChartSeriesTypesStockSeries extends dxChartSeriesTypesCommonSeries { /** * Configures data aggregation for the series. */ aggregation?: dxChartSeriesTypesStockSeriesAggregation; /** * Specifies which data source field provides arguments for series points. */ argumentField?: string; /** * Specifies series elements to be highlighted when a user pauses on a series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Configures point labels. */ label?: dxChartSeriesTypesStockSeriesLabel; /** * Specifies series elements to be highlighted when a user selects a point. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxChartSeriesTypesStockSeriesAggregation extends dxChartSeriesTypesCommonSeriesAggregation { /** * Specifies how to aggregate series points. */ method?: DevExpress.viz.dxChart.ChartFinancialSeriesAggregationMethod; } /** * @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 dxChartSeriesTypesStockSeriesLabel extends DevExpress.common.charts.SeriesLabel { /** * Customizes the text displayed by point labels. */ customizeText?: (pointInfo: any) => string; } /** * The CircularGauge is a UI component that indicates values on a circular numeric scale. */ export class dxCircularGauge extends BaseGauge {} module dxCircularGauge { export type CircularGaugeElementOrientation = | 'center' | 'inside' | 'outside'; export type CircularGaugeLabelOverlap = 'first' | 'last'; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxCircularGaugeOptions; /** * Specifies gauge range container properties. */ export type RangeContainer = BaseGaugeRangeContainer & { /** * Specifies the orientation of the range container in the CircularGauge UI component. */ orientation?: CircularGaugeElementOrientation; /** * Specifies the range container's width in pixels. */ width?: number; }; /** * Specifies a gauge's scale properties. */ export type Scale = BaseGaugeScale & { /** * Specifies common properties for scale labels. */ label?: ScaleLabel; /** * Specifies the orientation of scale ticks. */ orientation?: CircularGaugeElementOrientation; }; /** * Specifies common properties for scale labels. */ export type ScaleLabel = BaseGaugeScaleLabel & { /** * Specifies which label to hide in case of overlapping. */ hideFirstOrLast?: CircularGaugeLabelOverlap; /** * Specifies the spacing between scale labels and ticks. */ indentFromTick?: number; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo; } /** * * @deprecated * @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 dxCircularGaugeOptions extends BaseGaugeOptions { /** * Specifies the properties required to set the geometry of the CircularGauge UI component. */ geometry?: { /** * Specifies the end angle of the circular gauge's arc. */ endAngle?: number; /** * Specifies the start angle of the circular gauge's arc. */ startAngle?: number; }; /** * Specifies a custom template for content in the component's center. */ centerTemplate?: | template | (( component: dxCircularGauge, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies gauge range container properties. */ rangeContainer?: DevExpress.viz.dxCircularGauge.RangeContainer; /** * Specifies a gauge's scale properties. */ scale?: DevExpress.viz.dxCircularGauge.Scale; /** * Specifies the appearance properties of subvalue indicators. */ subvalueIndicator?: GaugeIndicator; /** * Specifies the appearance properties of the value indicator. */ valueIndicator?: GaugeIndicator; } /** * The Funnel is a UI component that visualizes a value at different stages. It helps assess value changes throughout these stages and identify potential issues. The Funnel UI component conveys information using different interactive elements (tooltips, labels, legend) and enables you to create not only a funnel, but also a pyramid chart. */ export class dxFunnel extends BaseWidget { /** * Cancels the selection of all funnel items. */ clearSelection(): void; /** * Provides access to all funnel items. */ getAllItems(): Array; getDataSource(): DevExpress.common.data.DataSource; /** * Hides all UI component tooltips. */ hideTooltip(): void; } module dxFunnel { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; export type FunnelAlgorithm = 'dynamicHeight' | 'dynamicSlope'; /** * * @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 FunnelItemInfo { /** * */ readonly item: Item; } /** * The type of the hoverChanged event handler's argument. */ export type HoverChangedEvent = DevExpress.common.core.events.EventInfo & FunnelItemInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = DevExpress.common.core.events.NativeEventInfo< dxFunnel, MouseEvent | PointerEvent > & FunnelItemInfo; /** * Configures the legend. */ export type Legend = DevExpress.common.charts.BaseLegend & { /** * Specifies the hint that appears when a user hovers the mouse pointer over a legend item. */ customizeHint?: (itemInfo: { item?: Item; text?: string }) => string; /** * Allows you to change the order, text, and visibility of legend items. */ customizeItems?: (items: Array) => Array; /** * Customizes the text displayed by legend items. */ customizeText?: (itemInfo: { item?: Item; text?: string }) => string; /** * Specifies an SVG element that serves as a custom legend item marker. */ markerTemplate?: | template | (( legendItem: LegendItem, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies whether the legend is visible. */ visible?: boolean; }; /** * The type of the legendClick event handler's argument. */ export type LegendClickEvent = DevExpress.common.core.events.NativeEventInfo< dxFunnel, MouseEvent | PointerEvent > & FunnelItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxFunnelOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & FunnelItemInfo; /** * */ export type Tooltip = BaseWidgetTooltip & { /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( info: { item?: Item; value?: number; valueText?: string; percent?: number; percentText?: string; }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Customizes a specific tooltip's appearance. */ customizeTooltip?: | ((info: { item?: Item; value?: number; valueText?: string; percent?: number; percentText?: string; }) => any) | undefined; }; } /** * @deprecated Use Item instead * @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 dxFunnelItem { /** * The item's argument. */ argument?: string | Date | number; /** * The item's original data object. */ data?: any; /** * Gets the funnel item's color specified in the data source or palette. */ getColor(): string; /** * Changes the funnel item's hover state. */ hover(state: boolean): void; /** * Indicates whether the funnel item is in the hover state. */ isHovered(): boolean; /** * Indicates whether the funnel item is selected. */ isSelected(): boolean; /** * The item's calculated percentage value. */ percent?: number; /** * Selects or cancels the funnel item's selection. */ select(state: boolean): void; /** * Shows the funnel item's tooltip. */ showTooltip(): void; /** * The item's value. */ value?: number; } /** * * @deprecated * @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 dxFunnelOptions extends BaseWidgetOptions { /** * Specifies adaptive layout properties. */ adaptiveLayout?: { /** * Specifies the minimum container height at which the layout begins to adapt. */ height?: number; /** * Specifies whether item labels should be kept when the UI component adapts the layout. */ keepLabels?: boolean; /** * Specifies the minimum container width at which the layout begins to adapt. */ width?: number; }; /** * Specifies the algorithm for building the funnel. */ algorithm?: DevExpress.viz.dxFunnel.FunnelAlgorithm; /** * Specifies which data source field provides arguments for funnel items. The argument identifies a funnel item and represents it on the legend. */ argumentField?: string; /** * Specifies which data source field provides colors for funnel items. If this field is absent, the palette provides the colors. */ colorField?: string; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether funnel items change their style when a user pauses on them. */ hoverEnabled?: boolean; /** * Turns the funnel upside down. */ inverted?: boolean; /** * Configures funnel items' appearance. */ item?: { /** * Configures a funnel item's border. */ border?: { /** * Colors a funnel item's border. */ color?: string | undefined; /** * Makes a funnel item's border visible. */ visible?: boolean | undefined; /** * Sets the width of a funnel item's border in pixels. */ width?: number | undefined; }; /** * Configures a funnel item's appearance when a user presses the item or hovers the mouse pointer over it. */ hoverStyle?: { /** * Configures a funnel item's border appearance when a user presses the item or hovers the mouse pointer over it. */ border?: { /** * Colors a funnel item's border when a user presses the item or hovers the mouse pointer over it. */ color?: string | undefined; /** * Shows a funnel item's border when a user presses the item or hovers the mouse pointer over it. */ visible?: boolean | undefined; /** * Thickens a funnel item's border when a user presses the item or hovers the mouse pointer over it. */ width?: number | undefined; }; /** * Applies hatching to a funnel item when a user presses the item or hovers the mouse pointer over it. */ hatching?: { /** * Specifies hatching line direction. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies the transparency of hatching lines. */ opacity?: number; /** * Specifies the distance between two side-by-side hatching lines in pixels. */ step?: number; /** * Specifies hatching lines' width in pixels. */ width?: number; }; }; /** * Configures a funnel item's appearance when a user selects it. */ selectionStyle?: { /** * Configures a funnel item's border appearance when a user selects this item. */ border?: { /** * Colors the selected funnel item's border. */ color?: string | undefined; /** * Shows the selected funnel item's border. */ visible?: boolean | undefined; /** * Thickens the selected funnel item's border. */ width?: number | undefined; }; /** * Applies hatching to a selected funnel item. */ hatching?: { /** * Specifies hatching line direction. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies hatching line transparency. */ opacity?: number; /** * Specifies the distance between two side-by-side hatching lines in pixels. */ step?: number; /** * Specifies hatching line width in pixels. */ width?: number; }; }; }; /** * Configures funnel item labels. */ label?: { /** * Colors the labels' background. The default color is inherited from the funnel items. */ backgroundColor?: string; /** * Configures the label borders. */ border?: { /** * Colors the label borders. */ color?: string; /** * Sets the label border dash style. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Shows the label borders. */ visible?: boolean; /** * Specifies the label border width. */ width?: number; }; /** * Configures label connectors. */ connector?: { /** * Colors label connectors. */ color?: string | undefined; /** * Specifies the transparency of label connectors. */ opacity?: number; /** * Shows label connectors. */ visible?: boolean; /** * Specifies the label connector width in pixels. */ width?: number; }; /** * Customizes labels' text. */ customizeText?: (itemInfo: { item?: DevExpress.viz.dxFunnel.Item; value?: number; valueText?: string; percent?: number; percentText?: string; }) => string; /** * Specifies labels' font properties. */ font?: DevExpress.common.charts.Font; /** * Formats the item value before displaying it in the label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies labels' position in relation to the funnel items. */ horizontalAlignment?: DevExpress.common.HorizontalEdge; /** * Moves labels from their initial positions. */ horizontalOffset?: number; /** * Specifies whether to display labels inside or outside funnel items or arrange them in columns. */ position?: DevExpress.common.charts.LabelPosition; /** * Specifies whether to show labels for items with zero value. */ showForZeroValues?: boolean; /** * Specifies what to do with label texts that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Controls the labels' visibility. */ visible?: boolean; /** * Specifies how to wrap label texts if they do not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; }; /** * Configures the legend. */ legend?: DevExpress.viz.dxFunnel.Legend; /** * Specifies the ratio between the height of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is 'dynamicHeight'. */ neckHeight?: number; /** * Specifies the ratio between the width of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is 'dynamicHeight'. */ neckWidth?: number; /** * A function that is executed after the pointer enters or leaves a funnel item. */ onHoverChanged?: (e: DevExpress.viz.dxFunnel.HoverChangedEvent) => void; /** * A function that is executed when a funnel item is clicked or tapped. */ onItemClick?: | ((e: DevExpress.viz.dxFunnel.ItemClickEvent) => void) | string; /** * A function that is executed when a legend item is clicked or tapped. */ onLegendClick?: | ((e: DevExpress.viz.dxFunnel.LegendClickEvent) => void) | string; /** * A function that is executed when a funnel item is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.viz.dxFunnel.SelectionChangedEvent ) => void; /** * Sets the palette to be used to colorize funnel items. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of funnel items. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * Specifies how item labels should behave when they overlap. */ resolveLabelOverlapping?: DevExpress.common.charts.ShiftLabelOverlap; /** * Specifies whether a single or multiple funnel items can be in the selected state at a time. Assigning 'none' disables the selection feature. */ selectionMode?: DevExpress.common.SingleMultipleOrNone; /** * Specifies whether to sort funnel items. */ sortData?: boolean; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: DevExpress.viz.dxFunnel.Tooltip; /** * Specifies which data source field provides values for funnel items. The value defines a funnel item's area. */ valueField?: string; } /** * The LinearGauge is a UI component that indicates values on a linear numeric scale. */ export class dxLinearGauge extends BaseGauge {} module dxLinearGauge { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxLinearGaugeOptions; /** * Specifies gauge range container properties. */ export type RangeContainer = BaseGaugeRangeContainer & { /** * Specifies the orientation of the range container. Applies only if the geometry.orientation property is 'vertical'. */ horizontalOrientation?: DevExpress.common.HorizontalAlignment; /** * Specifies the orientation of the range container. Applies only if the geometry.orientation property is 'horizontal'. */ verticalOrientation?: DevExpress.common.VerticalAlignment; /** * Specifies the width of the range container's start and end boundaries in the LinearGauge UI component. */ width?: | { /** * Specifies a start width of a range container. */ start?: number; /** * Specifies an end width of a range container. */ end?: number; } | number; }; /** * Specifies the gauge's scale properties. */ export type Scale = BaseGaugeScale & { /** * Specifies the orientation of scale ticks. Applies only if the geometry.orientation property is 'vertical'. */ horizontalOrientation?: DevExpress.common.HorizontalAlignment; /** * Specifies common properties for scale labels. */ label?: ScaleLabel; /** * Specifies the minimum distance between two neighboring major ticks in pixels. */ scaleDivisionFactor?: number; /** * Specifies the orientation of scale ticks. Applies only if the geometry.orientation property is 'horizontal'. */ verticalOrientation?: DevExpress.common.VerticalAlignment; }; /** * Specifies common properties for scale labels. */ export type ScaleLabel = BaseGaugeScaleLabel & { /** * Specifies the spacing between scale labels and ticks. */ indentFromTick?: number; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseGauge.TooltipInfo; } /** * * @deprecated * @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 dxLinearGaugeOptions extends BaseGaugeOptions { /** * Specifies the properties required to set the geometry of the LinearGauge UI component. */ geometry?: { /** * Indicates whether to display the LinearGauge UI component vertically or horizontally. */ orientation?: DevExpress.common.Orientation; }; /** * Specifies gauge range container properties. */ rangeContainer?: DevExpress.viz.dxLinearGauge.RangeContainer; /** * Specifies the gauge's scale properties. */ scale?: DevExpress.viz.dxLinearGauge.Scale; /** * Specifies the appearance properties of subvalue indicators. */ subvalueIndicator?: GaugeIndicator; /** * Specifies the appearance properties of the value indicator. */ valueIndicator?: GaugeIndicator; } /** * The PieChart is a UI component that visualizes data as a circle divided into sectors that each represents a portion of the whole. */ export class dxPieChart extends BaseChart { /** * Gets the radius of the doughnut hole in pixels. Applies only when the type is 'doughnut' or 'donut'. */ getInnerRadius(): number; } module dxPieChart { /** * Specifies adaptive layout properties. */ export type AdaptiveLayout = BaseChartAdaptiveLayout & { /** * Specifies whether point labels should be kept when the UI component adapts the layout. */ keepLabels?: boolean; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the done event handler's argument. */ export type DoneEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * Specifies PieChart legend properties. */ export type Legend = BaseChartLegend & { /** * Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ customizeHint?: (pointInfo: { pointName?: any; pointIndex?: number; pointColor?: string; }) => string; /** * Allows you to change the order, text, and visibility of legend items. */ customizeItems?: (items: Array) => Array; /** * Specifies a callback function that returns the text to be displayed by a legend item. */ customizeText?: (pointInfo: { pointName?: any; pointIndex?: number; pointColor?: string; }) => string; /** * Specifies what chart elements to highlight when a corresponding item in the legend is hovered over. */ hoverMode?: PieChartLegendHoverMode; /** * Specifies an SVG element that serves as a custom legend item marker. */ markerTemplate?: | template | (( legendItem: LegendItem, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; }; /** * The type of the legendClick event handler's argument. */ export type LegendClickEvent = DevExpress.common.core.events.NativeEventInfo< dxPieChart, MouseEvent | PointerEvent > & { /** * */ readonly target: string | number; /** * */ readonly points: Array; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type PieChartAnnotationLocation = 'center' | 'edge'; export type PieChartLegendHoverMode = 'none' | 'allArgumentPoints'; export type PieChartSegmentDirection = 'anticlockwise' | 'clockwise'; export type PieChartSeriesInteractionMode = 'none' | 'onlyPoint'; export type PieChartType = 'donut' | 'doughnut' | 'pie'; /** * The type of the pointClick event handler's argument. */ export type PointClickEvent = DevExpress.common.core.events.NativeEventInfo< dxPieChart, MouseEvent | PointerEvent > & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointHoverChanged event handler's argument. */ export type PointHoverChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointSelectionChanged event handler's argument. */ export type PointSelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; export type Properties = dxPieChartOptions; export type SmallValuesGroupingMode = | 'none' | 'smallValueThreshold' | 'topN'; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; } /** * * @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 dxPieChartAnnotationConfig extends dxPieChartCommonAnnotationConfig { /** * Specifies the annotation's name. */ name?: string | undefined; } /** * * @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 dxPieChartCommonAnnotationConfig extends BaseWidgetAnnotationConfig { /** * Specifies an annotation's position on the surface of a specific argument. */ location?: DevExpress.viz.dxPieChart.PieChartAnnotationLocation; /** * Positions the annotation relative to a specific argument. */ argument?: number | Date | string | undefined; /** * Anchors the annotation to a series point. Accepts the name of the point's series. */ series?: string | undefined; /** * Customizes the text and appearance of the annotation's tooltip. */ customizeTooltip?: | ((annotation: dxPieChartAnnotationConfig | any) => any) | undefined; /** * Specifies a custom template for the annotation. Applies only if the type is 'custom'. */ template?: | template | (( annotation: dxPieChartAnnotationConfig | any, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies a custom template for an annotation's tooltip. */ tooltipTemplate?: | template | (( annotation: dxPieChartAnnotationConfig | any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; } /** * * @deprecated * @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 dxPieChartOptions extends BaseChartOptions { /** * Specifies adaptive layout properties. */ adaptiveLayout?: DevExpress.viz.dxPieChart.AdaptiveLayout; /** * Specifies a custom template for content in the pie's center. */ centerTemplate?: | template | (( component: dxPieChart, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * An object defining the configuration properties that are common for all series of the PieChart UI component. */ commonSeriesSettings?: any; /** * Specifies the diameter of the pie. */ diameter?: number | undefined; /** * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1. */ innerRadius?: number; /** * Specifies PieChart legend properties. */ legend?: DevExpress.viz.dxPieChart.Legend; /** * Specifies the minimum diameter of the pie. */ minDiameter?: number; /** * A function that is executed when a legend item is clicked or tapped. */ onLegendClick?: | ((e: DevExpress.viz.dxPieChart.LegendClickEvent) => void) | string; /** * Sets the palette to be used to colorize series and their elements. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies how a chart must behave when point labels overlap. */ resolveLabelOverlapping?: DevExpress.common.charts.ShiftLabelOverlap; /** * Specifies the direction that the pie chart segments will occupy. */ segmentsDirection?: DevExpress.viz.dxPieChart.PieChartSegmentDirection; /** * Specifies properties for the series of the PieChart UI component. */ series?: PieChartSeries | Array | undefined; /** * Defines properties for the series template. */ seriesTemplate?: { /** * Specifies a callback function that returns a series object with individual series settings. */ customizeSeries?: (seriesName: any) => PieChartSeries; /** * Specifies a data source field that represents the series name. */ nameField?: string; }; /** * Allows you to display several adjoining pies in the same size. */ sizeGroup?: string | undefined; /** * Specifies the angle in arc degrees from which the first segment of a pie chart should start. */ startAngle?: number; /** * Specifies the type of the pie chart series. */ type?: DevExpress.viz.dxPieChart.PieChartType; /** * Specifies the annotation collection. */ annotations?: Array; /** * Specifies settings common for all annotations in the PieChart. */ commonAnnotationSettings?: dxPieChartCommonAnnotationConfig; /** * Customizes an individual annotation. */ customizeAnnotation?: | (( annotation: dxPieChartAnnotationConfig | any ) => dxPieChartAnnotationConfig) | undefined; } /** * This section lists the objects that define properties to be used to configure series of particular types. * @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 dxPieChartSeriesTypes { /** * An object that defines configuration properties for chart series. */ CommonPieChartSeries?: dxPieChartSeriesTypesCommonPieChartSeries; /** * An object defining a series of the doughnut type. */ DoughnutSeries?: any; /** * An object defining a series of the pie type. */ PieSeries?: 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 interface dxPieChartSeriesTypesCommonPieChartSeries { /** * Specifies the data source field that provides arguments for series points. */ argumentField?: string; /** * Specifies the required type for series arguments. */ argumentType?: DevExpress.common.charts.ChartsDataType | undefined; /** * An object defining the series border configuration properties. */ border?: { /** * Sets a border color for a series. */ color?: string | undefined; /** * Specifies a dash style for the border of a series point. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets border visibility for a series. */ visible?: boolean; /** * Sets a border width for a series in pixels. */ width?: number; }; /** * Specifies a series color. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the chart elements to highlight when a series is hovered over. */ hoverMode?: DevExpress.viz.dxPieChart.PieChartSeriesInteractionMode; /** * An object defining configuration properties for a hovered series. */ hoverStyle?: { /** * An object defining the border properties for a hovered series. */ border?: { /** * Sets a border color for the series when it is hovered over. */ color?: string | undefined; /** * Specifies a dash style for the border of a series point when this point is hovered over. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets border visibility for a hovered series. */ visible?: boolean; /** * Sets a border width for a hovered series. */ width?: number; }; /** * Sets the color for the series when it is hovered over. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the hatching properties to be applied when a point is hovered over. */ hatching?: { /** * Specifies how to apply hatching to highlight the hovered point. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies the opacity of hatching lines. */ opacity?: number; /** * Specifies the distance between two hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; }; /** * Specifies whether to lighten the series when a user points to it. */ highlight?: boolean; }; /** * An object defining the label configuration properties. */ label?: { /** * Formats the point argument before it is displayed in the point label. To format the point value, use the format property. */ argumentFormat?: DevExpress.common.core.localization.Format | undefined; /** * Colors the point labels' background. The default color is inherited from the points. */ backgroundColor?: string | undefined; /** * Specifies border properties for point labels. */ border?: { /** * Specifies a border color for point labels. */ color?: string | undefined; /** * Specifies a dash style for the borders of point labels. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Indicates whether or not borders are visible in point labels. */ visible?: boolean; /** * Specifies the border width for point labels. */ width?: number; }; /** * Specifies connector properties for series point labels. */ connector?: { /** * Specifies the color of label connectors. */ color?: string | undefined; /** * Indicates whether or not label connectors are visible. */ visible?: boolean; /** * Specifies the width of label connectors. */ width?: number; }; /** * Specifies a callback function that returns the text to be displayed by point labels. */ customizeText?: (pointInfo: any) => string; /** * Specifies font properties for the text displayed in point labels. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a point label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies a label position relative to the chart. */ position?: DevExpress.common.charts.LabelPosition; /** * Specifies how to shift labels from their initial position in a radial direction in pixels. */ radialOffset?: number; /** * Specifies the angle used to rotate point labels from their initial position. */ rotationAngle?: number; /** * Specifies what to do with label texts that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Specifies the visibility of point labels. */ visible?: boolean; /** * Specifies how to wrap label texts if they do not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; /** * Specifies the label's text. */ displayFormat?: string | undefined; }; /** * Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ maxLabelCount?: number | undefined; /** * Specifies a minimal size of a displayed pie segment. */ minSegmentSize?: number | undefined; /** * Specifies the chart elements to highlight when the series is selected. */ selectionMode?: DevExpress.viz.dxPieChart.PieChartSeriesInteractionMode; /** * An object defining configuration properties for the series when it is selected. */ selectionStyle?: { /** * An object defining the border properties for a selected series. */ border?: { /** * Sets a border color for a selected series. */ color?: string | undefined; /** * Specifies a dash style for the border of a selected series point. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets a border visibility for a selected series. */ visible?: boolean; /** * Sets a border width for a selected series. */ width?: number; }; /** * Sets the color for a series when it is selected. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the hatching properties to be applied when a point is selected. */ hatching?: { /** * Specifies how to apply hatching to highlight the selected point. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies the opacity of hatching lines. */ opacity?: number; /** * Specifies the distance between two hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; }; /** * Specifies whether to lighten the series when a user selects it. */ highlight?: boolean; }; /** * Specifies chart segment grouping properties. */ smallValuesGrouping?: { /** * Specifies the name of the grouped chart segment. This name represents the segment in the chart legend. */ groupName?: string; /** * Specifies the segment grouping mode. */ mode?: DevExpress.viz.dxPieChart.SmallValuesGroupingMode; /** * Specifies a threshold for segment values. */ threshold?: number | undefined; /** * Specifies how many segments must not be grouped. */ topCount?: number | undefined; }; /** * Specifies the name of the data source field that provides data about a point. */ tagField?: string; /** * Specifies the data source field that provides values for series points. */ valueField?: string; } /** * The PolarChart is a UI component that visualizes data in a polar coordinate system. */ export class dxPolarChart extends BaseChart { /** * Gets a value axis. */ getValueAxis(): chartAxisObject; /** * Resets the value axis' visual range to the data range or to the whole range if it is within the data range. */ resetVisualRange(): void; } module dxPolarChart { /** * Specifies adaptive layout properties. */ export type AdaptiveLayout = BaseChartAdaptiveLayout & { /** * Specifies the minimum container height at which the layout begins to adapt. */ height?: number; /** * Specifies the minimum container width at which the layout begins to adapt. */ width?: number; }; /** * Specifies argument axis properties for the PolarChart UI component. */ export type ArgumentAxis = CommonAxisSettings & { /** * Specifies the desired type of axis values. */ argumentType?: DevExpress.common.charts.ChartsDataType | undefined; /** * Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the 'continuous' and 'logarithmic' types. */ axisDivisionFactor?: number; /** * Specifies the order of categories on an axis of the 'discrete' type. */ categories?: Array; /** * Defines an array of the argument axis constant lines. */ constantLines?: Array; /** * Specifies whether or not to display the first point at the angle specified by the startAngle property. */ firstPointOnStartAngle?: boolean; /** * Specifies the elements that will be highlighted when the argument axis is hovered over. */ hoverMode?: DevExpress.common.charts.ArgumentAxisHoverMode; /** * Specifies properties for argument axis labels. */ label?: ArgumentAxisLabel; /** * Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number | undefined; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ logarithmBase?: number; /** * Specifies the properties of the minor ticks. */ minorTick?: ArgumentAxisMinorTick; /** * Specifies the number of minor ticks between two neighboring major ticks. */ minorTickCount?: number | undefined; /** * Specifies the interval between minor ticks. */ minorTickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the value to be used as the origin for the argument axis. */ originValue?: number | undefined; /** * Specifies the period of the argument values in the data source. */ period?: number | undefined; /** * Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise. */ startAngle?: number; /** * Specifies properties for argument axis strips. */ strips?: Array; /** * An object defining the configuration properties for axis ticks. */ tick?: ArgumentAxisTick; /** * Specifies an interval between axis ticks/grid lines. */ tickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the required type of the argument axis. */ type?: DevExpress.common.charts.AxisScaleType | undefined; }; /** * The type of the argumentAxisClick event handler's argument. */ export type ArgumentAxisClickEvent = DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | PointerEvent > & { /** * */ readonly argument: Date | number | string; }; /** * Defines an array of the argument axis constant lines. */ export type ArgumentAxisConstantLines = CommonAxisSettingsConstantLineStyle & { /** * Specifies whether to display the constant line behind or in front of the series. */ displayBehindSeries?: boolean; /** * Specifies whether to extend the axis to display the constant line. */ extendAxis?: boolean; /** * An object defining constant line label properties. */ label?: ArgumentAxisConstantLinesLabel; /** * Specifies a value to be displayed by a constant line. */ value?: number | Date | string | undefined; }; /** * An object defining constant line label properties. */ export type ArgumentAxisConstantLinesLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Specifies the text to be displayed in a constant line label. */ text?: string | undefined; }; /** * Specifies properties for argument axis labels. */ export type ArgumentAxisLabel = CommonAxisSettingsLabel & { /** * Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the argument axis. */ customizeHint?: (argument: { value?: Date | number | string; valueText?: string; }) => string; /** * Specifies a callback function that returns the text to be displayed by argument axis labels. */ customizeText?: (argument: { value?: Date | number | string; valueText?: string; }) => string; /** * Formats a value before it is displayed in an axis label. */ format?: DevExpress.common.core.localization.Format | undefined; }; /** * */ export type ArgumentAxisMinorTick = CommonAxisSettingsMinorTick & { /** * Shifts minor ticks from the reference position. */ shift?: number; }; /** * Specifies properties for argument axis strips. */ export type ArgumentAxisStrips = CommonAxisSettingsStripStyle & { /** * Specifies a color for a strip. */ color?: string | undefined; /** * Specifies an end value for a strip. */ endValue?: number | Date | string | undefined; /** * An object that defines the label configuration properties of a strip. */ label?: ArgumentAxisStripsLabel; /** * Specifies a start value for a strip. */ startValue?: number | Date | string | undefined; }; /** * An object that defines the label configuration properties of a strip. */ export type ArgumentAxisStripsLabel = CommonAxisSettingsStripStyleLabel & { /** * Specifies the text displayed in a strip. */ text?: string | undefined; }; /** * */ export type ArgumentAxisTick = CommonAxisSettingsTick & { /** * Shifts ticks from the reference position. */ shift?: number; }; /** * An object defining the configuration properties that are common for all axes of the PolarChart UI component. */ export type CommonAxisSettings = { /** * Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only. */ allowDecimals?: boolean | undefined; /** * Specifies the color of the line that represents an axis. */ color?: string; /** * Specifies the appearance of all the UI component's constant lines. */ constantLineStyle?: CommonAxisSettingsConstantLineStyle; /** * Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ discreteAxisDivisionMode?: DevExpress.common.charts.DiscreteAxisDivisionMode; /** * Specifies whether to force the axis to start and end on ticks. */ endOnTick?: boolean | undefined; /** * An object defining the configuration properties for the grid lines of an axis in the PolarChart UI component. */ grid?: { /** * Specifies a color for grid lines. */ color?: string; /** * Specifies an opacity for grid lines. */ opacity?: number | undefined; /** * Indicates whether or not the grid lines of an axis are visible. */ visible?: boolean; /** * Specifies the width of grid lines. */ width?: number; }; /** * Indicates whether or not an axis is inverted. */ inverted?: boolean; /** * An object defining the label configuration properties that are common for all axes in the PolarChart UI component. */ label?: CommonAxisSettingsLabel; /** * Specifies the properties of the minor grid. */ minorGrid?: { /** * Specifies a color for the lines of the minor grid. */ color?: string; /** * Specifies an opacity for the lines of the minor grid. */ opacity?: number | undefined; /** * Indicates whether the minor grid is visible or not. */ visible?: boolean; /** * Specifies a width for the lines of the minor grid. */ width?: number; }; /** * Specifies the properties of the minor ticks. */ minorTick?: CommonAxisSettingsMinorTick; /** * Specifies the opacity of the line that represents an axis. */ opacity?: number | undefined; /** * An object defining configuration properties for strip style. */ stripStyle?: CommonAxisSettingsStripStyle; /** * An object defining the configuration properties for axis ticks. */ tick?: CommonAxisSettingsTick; /** * Indicates whether or not the line that represents an axis in a chart is visible. */ visible?: boolean; /** * Specifies the width of the line that represents an axis in the chart. */ width?: number; }; /** * Specifies the appearance of all the UI component's constant lines. */ export type CommonAxisSettingsConstantLineStyle = { /** * Specifies a color for a constant line. */ color?: string; /** * Specifies a dash style for a constant line. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * An object defining constant line label properties. */ label?: CommonAxisSettingsConstantLineStyleLabel; /** * Specifies a constant line width in pixels. */ width?: number; }; /** * An object defining constant line label properties. */ export type CommonAxisSettingsConstantLineStyleLabel = { /** * Specifies font properties for a constant line label. */ font?: DevExpress.common.charts.Font; /** * Indicates whether or not to display labels for the axis constant lines. */ visible?: boolean; }; /** * An object defining the label configuration properties that are common for all axes in the PolarChart UI component. */ export type CommonAxisSettingsLabel = { /** * Specifies font properties for axis labels. */ font?: DevExpress.common.charts.Font; /** * Specifies the spacing between an axis and its labels in pixels. */ indentFromAxis?: number; /** * Decides how to arrange axis labels when there is not enough space to keep all of them. */ overlappingBehavior?: DevExpress.common.charts.LabelOverlap; /** * Indicates whether or not axis labels are visible. */ visible?: boolean; }; /** * Specifies the properties of the minor ticks. */ export type CommonAxisSettingsMinorTick = { /** * Specifies a color for the minor ticks. */ color?: string; /** * Specifies minor tick length. */ length?: number; /** * Specifies an opacity for the minor ticks. */ opacity?: number; /** * Indicates whether or not the minor ticks are displayed on an axis. */ visible?: boolean; /** * Specifies minor tick width. */ width?: number; }; /** * An object defining configuration properties for strip style. */ export type CommonAxisSettingsStripStyle = { /** * An object defining the configuration properties for a strip label style. */ label?: CommonAxisSettingsStripStyleLabel; }; /** * An object defining the configuration properties for a strip label style. */ export type CommonAxisSettingsStripStyleLabel = { /** * Specifies font properties for a strip label. */ font?: DevExpress.common.charts.Font; }; /** * An object defining the configuration properties for axis ticks. */ export type CommonAxisSettingsTick = { /** * Specifies ticks color. */ color?: string; /** * Specifies tick length. */ length?: number; /** * Specifies tick opacity. */ opacity?: number | undefined; /** * Indicates whether or not ticks are visible on an axis. */ visible?: boolean; /** * Specifies tick width. */ width?: number; }; /** * An object defining the configuration properties that are common for all series of the PolarChart UI component. */ export type CommonSeriesSettings = dxPolarChartSeriesTypesCommonPolarChartSeries & { /** * An object that specifies configuration properties for all series of the area type in the chart. */ area?: any; /** * An object that specifies configuration properties for all series of the 'bar' type in the chart. */ bar?: any; /** * An object that specifies configuration properties for all series of the 'line' type in the chart. */ line?: any; /** * An object that specifies configuration properties for all series of the 'scatter' type in the chart. */ scatter?: any; /** * An object that specifies configuration properties for all series of the 'stackedBar' type in the chart. */ stackedbar?: any; /** * Sets a series type. */ type?: PolarChartSeriesType; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the done event handler's argument. */ export type DoneEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * Specifies the properties of a chart's legend. */ export type Legend = BaseChartLegend & { /** * Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item. */ customizeHint?: (seriesInfo: { seriesName?: any; seriesIndex?: number; seriesColor?: string; }) => string; /** * Specifies a callback function that returns the text to be displayed by legend items. */ customizeText?: (seriesInfo: { seriesName?: any; seriesIndex?: number; seriesColor?: string; }) => string; /** * Specifies what series elements to highlight when a corresponding item in the legend is hovered over. */ hoverMode?: DevExpress.common.charts.LegendHoverMode; }; /** * The type of the legendClick event handler's argument. */ export type LegendClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | PointerEvent > & { /** * */ readonly target: polarChartSeriesObject; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; /** * The type of the pointClick event handler's argument. */ export type PointClickEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | PointerEvent > & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointHoverChanged event handler's argument. */ export type PointHoverChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; /** * The type of the pointSelectionChanged event handler's argument. */ export type PointSelectionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.PointInteractionInfo; export type PolarChartSeriesType = | 'area' | 'bar' | 'line' | 'scatter' | 'stackedbar'; export type Properties = dxPolarChartOptions; /** * The type of the seriesClick event handler's argument. */ export type SeriesClickEvent = DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | PointerEvent > & { /** * */ readonly target: polarChartSeriesObject; }; /** * The type of the seriesHoverChanged event handler's argument. */ export type SeriesHoverChangedEvent = DevExpress.common.core.events.EventInfo & SeriesInteractionInfo; /** * * @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 SeriesInteractionInfo { /** * */ target: polarChartSeriesObject; } /** * The type of the seriesSelectionChanged event handler's argument. */ export type SeriesSelectionChangedEvent = DevExpress.common.core.events.EventInfo & SeriesInteractionInfo; /** * */ export type Tooltip = BaseChartTooltip & { /** * Specifies whether the tooltip is shared across all series points with the same argument. */ shared?: boolean; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseChart.TooltipInfo; /** * Specifies value axis properties for the PolarChart UI component. */ export type ValueAxis = CommonAxisSettings & { /** * Specifies a coefficient for dividing the value axis. */ axisDivisionFactor?: number; /** * Specifies the order of categories on an axis of the 'discrete' type. */ categories?: Array; /** * Defines an array of the value axis constant lines. */ constantLines?: Array; /** * Specifies whether to force the axis to start and end on ticks. */ endOnTick?: boolean; /** * Specifies properties for value axis labels. */ label?: ValueAxisLabel; /** * Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number | undefined; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic axis. */ logarithmBase?: number; /** * Specifies a coefficient that determines the spacing between the maximum series point and the axis. */ maxValueMargin?: number | undefined; /** * Specifies a coefficient that determines the spacing between the minimum series point and the axis. */ minValueMargin?: number | undefined; /** * Specifies the minimum length of the visual range. */ minVisualRangeLength?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the number of minor ticks between two neighboring major ticks. */ minorTickCount?: number | undefined; /** * Specifies the interval between minor ticks. */ minorTickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies whether or not to indicate a zero value on the value axis. */ showZero?: boolean | undefined; /** * Specifies properties for value axis strips. */ strips?: Array; /** * An object defining the configuration properties for axis ticks. */ tick?: ValueAxisTick; /** * Specifies an interval between axis ticks/grid lines. */ tickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the required type of the value axis. */ type?: DevExpress.common.charts.AxisScaleType | undefined; /** * Indicates whether to display series with indents from axis boundaries. */ valueMarginsEnabled?: boolean; /** * Specifies the desired type of axis values. */ valueType?: DevExpress.common.charts.ChartsDataType | undefined; /** * Defines the axis' displayed range. Cannot be wider than the wholeRange. */ visualRange?: | DevExpress.common.charts.VisualRange | Array; /** * Specifies how the axis's visual range should behave when the PolarChart data is updated. */ visualRangeUpdateMode?: DevExpress.common.charts.ValueAxisVisualRangeUpdateMode; /** * Defines the range where the axis can be zoomed. */ wholeRange?: | DevExpress.common.charts.VisualRange | Array | undefined; }; /** * Defines an array of the value axis constant lines. */ export type ValueAxisConstantLines = CommonAxisSettingsConstantLineStyle & { /** * Specifies whether to display the constant line behind or in front of the series. */ displayBehindSeries?: boolean; /** * Specifies whether to extend the axis to display the constant line. */ extendAxis?: boolean; /** * An object defining constant line label properties. */ label?: ValueAxisConstantLinesLabel; /** * Specifies a value to be displayed by a constant line. */ value?: number | Date | string | undefined; }; /** * An object defining constant line label properties. */ export type ValueAxisConstantLinesLabel = CommonAxisSettingsConstantLineStyleLabel & { /** * Specifies the text to be displayed in a constant line label. */ text?: string | undefined; }; /** * Specifies properties for value axis labels. */ export type ValueAxisLabel = CommonAxisSettingsLabel & { /** * Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis. */ customizeHint?: (axisValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Specifies a callback function that returns the text to be displayed in value axis labels. */ customizeText?: (axisValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Formats a value before it is displayed in an axis label. */ format?: DevExpress.common.core.localization.Format | undefined; }; /** * Specifies properties for value axis strips. */ export type ValueAxisStrips = CommonAxisSettingsStripStyle & { /** * Specifies a color for a strip. */ color?: string | undefined; /** * Specifies an end value for a strip. */ endValue?: number | Date | string | undefined; /** * An object that defines the label configuration properties of a strip. */ label?: ValueAxisStripsLabel; /** * Specifies a start value for a strip. */ startValue?: number | Date | string | undefined; }; /** * An object that defines the label configuration properties of a strip. */ export type ValueAxisStripsLabel = CommonAxisSettingsStripStyleLabel & { /** * Specifies the text displayed in a strip. */ text?: string | undefined; }; /** * */ export type ValueAxisTick = CommonAxisSettingsTick & { /** * Indicates whether or not ticks are visible on an axis. */ visible?: boolean; }; /** * The type of the zoomEnd event handler's argument. */ export type ZoomEndEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | TouchEvent > & { /** * */ readonly axis: chartAxisObject; /** * */ readonly range: DevExpress.common.charts.VisualRange; /** * */ readonly previousRange: DevExpress.common.charts.VisualRange; /** * */ readonly actionType: DevExpress.common.charts.ZoomPanAction; /** * */ readonly zoomFactor: number; /** * */ readonly shift: number; }; /** * The type of the zoomStart event handler's argument. */ export type ZoomStartEvent = DevExpress.common.core.events.Cancelable & DevExpress.common.core.events.NativeEventInfo< dxPolarChart, MouseEvent | TouchEvent > & { /** * */ readonly axis: chartAxisObject; /** * */ readonly range: DevExpress.common.charts.VisualRange; /** * */ readonly actionType: DevExpress.common.charts.ZoomPanAction; }; } /** * * @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 dxPolarChartAnnotationConfig extends dxPolarChartCommonAnnotationConfig { /** * Specifies the annotation's name. */ name?: string | undefined; } /** * * @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 dxPolarChartCommonAnnotationConfig extends BaseChartAnnotationConfig { /** * Specifies the angle between the startAngle and the radius. */ angle?: number | undefined; /** * Places an annotation at the specified distance from the center of the UI component. */ radius?: number | undefined; /** * Customizes the text and appearance of the annotation's tooltip. */ customizeTooltip?: | ((annotation: dxPolarChartAnnotationConfig | any) => any) | undefined; /** * Specifies a custom template for the annotation. Applies only if the type is 'custom'. */ template?: | template | (( annotation: dxPolarChartAnnotationConfig | any, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies a custom template for an annotation's tooltip. */ tooltipTemplate?: | template | (( annotation: dxPolarChartAnnotationConfig | any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; } /** * * @deprecated * @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 dxPolarChartOptions extends BaseChartOptions { /** * Specifies adaptive layout properties. */ adaptiveLayout?: DevExpress.viz.dxPolarChart.AdaptiveLayout; /** * Specifies the annotation collection. */ annotations?: Array; /** * Specifies argument axis properties for the PolarChart UI component. */ argumentAxis?: DevExpress.viz.dxPolarChart.ArgumentAxis; /** * Controls the padding and consequently the angular width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. */ barGroupPadding?: number; /** * Specifies a fixed angular width for groups of bars with the same argument, measured in degrees. Takes precedence over the barGroupPadding property. */ barGroupWidth?: number | undefined; /** * Specifies settings common for all annotations in the PolarChart. */ commonAnnotationSettings?: dxPolarChartCommonAnnotationConfig; /** * An object defining the configuration properties that are common for all axes of the PolarChart UI component. */ commonAxisSettings?: DevExpress.viz.dxPolarChart.CommonAxisSettings; /** * An object defining the configuration properties that are common for all series of the PolarChart UI component. */ commonSeriesSettings?: DevExpress.viz.dxPolarChart.CommonSeriesSettings; /** * Specifies the color of the parent page element. */ containerBackgroundColor?: string; /** * Customizes an individual annotation. */ customizeAnnotation?: | (( annotation: dxPolarChartAnnotationConfig | any ) => dxPolarChartAnnotationConfig) | undefined; /** * An object providing properties for managing data from a data source. */ dataPrepareSettings?: { /** * Specifies whether or not to validate the values from a data source. */ checkTypeForAllData?: boolean; /** * Specifies whether or not to convert the values from a data source into the data type of an axis. */ convertToAxisDataType?: boolean; /** * Specifies how to sort the series points. */ sortingMethod?: | boolean | (( a: { arg?: Date | number | string; val?: Date | number | string }, b: { arg?: Date | number | string; val?: Date | number | string } ) => number); }; /** * Specifies the properties of a chart's legend. */ legend?: DevExpress.viz.dxPolarChart.Legend; /** * Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. */ negativesAsZeroes?: boolean; /** * A function that is executed when a label on the argument axis is clicked or tapped. */ onArgumentAxisClick?: | ((e: DevExpress.viz.dxPolarChart.ArgumentAxisClickEvent) => void) | string; /** * A function that is executed when a legend item is clicked or tapped. */ onLegendClick?: | ((e: DevExpress.viz.dxPolarChart.LegendClickEvent) => void) | string; /** * A function that is executed when a series is clicked or tapped. */ onSeriesClick?: | ((e: DevExpress.viz.dxPolarChart.SeriesClickEvent) => void) | string; /** * A function that is executed after the pointer enters or leaves a series. */ onSeriesHoverChanged?: ( e: DevExpress.viz.dxPolarChart.SeriesHoverChangedEvent ) => void; /** * A function that is executed when a series is selected or selection is canceled. */ onSeriesSelectionChanged?: ( e: DevExpress.viz.dxPolarChart.SeriesSelectionChangedEvent ) => void; /** * A function that is executed when zooming or panning ends. */ onZoomEnd?: (e: DevExpress.viz.dxPolarChart.ZoomEndEvent) => void; /** * A function that is executed when zooming or panning begins. */ onZoomStart?: (e: DevExpress.viz.dxPolarChart.ZoomStartEvent) => void; /** * Specifies how the chart must behave when series point labels overlap. */ resolveLabelOverlapping?: DevExpress.common.charts.LabelOverlap; /** * Specifies properties for PolarChart UI component series. */ series?: PolarChartSeries | Array | undefined; /** * Specifies whether a single series or multiple series can be selected in the chart. */ seriesSelectionMode?: DevExpress.common.SingleOrMultiple; /** * Defines properties for the series template. */ seriesTemplate?: { /** * Specifies a callback function that returns a series object with individual series settings. */ customizeSeries?: (seriesName: any) => PolarChartSeries; /** * Specifies a data source field that represents the series name. */ nameField?: string; }; /** * Configures tooltips. */ tooltip?: DevExpress.viz.dxPolarChart.Tooltip; /** * Indicates whether to display a 'spider web'. */ useSpiderWeb?: boolean; /** * Specifies value axis properties for the PolarChart UI component. */ valueAxis?: DevExpress.viz.dxPolarChart.ValueAxis; } /** * This section lists objects that define properties used to configure series of specific types. * @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 dxPolarChartSeriesTypes { /** * An object that defines configuration properties for polar chart series. */ CommonPolarChartSeries?: dxPolarChartSeriesTypesCommonPolarChartSeries; /** * An object defining a series of the area type. */ areapolarseries?: dxPolarChartSeriesTypesAreapolarseries; /** * An object defining a series of the bar type. */ barpolarseries?: dxPolarChartSeriesTypesBarpolarseries; /** * An object defining a series of the line type. */ linepolarseries?: dxPolarChartSeriesTypesLinepolarseries; /** * An object defining a series of the scatter type. */ scatterpolarseries?: any; /** * An object defining a series of the stackedBar type. */ stackedbarpolarseries?: dxPolarChartSeriesTypesStackedbarpolarseries; } /** * @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 dxPolarChartSeriesTypesAreapolarseries extends dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies series elements to be highlighted when a user points to the series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * An object defining configuration properties for points in line and area series. */ point?: dxPolarChartSeriesTypesAreapolarseriesPoint; /** * Specifies series elements to be highlighted when a user selects the series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxPolarChartSeriesTypesAreapolarseriesPoint extends dxPolarChartSeriesTypesCommonPolarChartSeriesPoint { /** * Specifies the points visibility for a line and area series. */ visible?: 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 interface dxPolarChartSeriesTypesBarpolarseries extends dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies series elements to be highlighted when a user points to the series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * Specifies series elements to be highlighted when a user selects the series. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies the data source field that provides arguments for series points. */ argumentField?: string; /** * Controls the padding and consequently the angular width of all bars in a series using relative units. Ignored if the barWidth property is set. */ barPadding?: number | undefined; /** * Specifies a fixed angular width for all bars in a series, measured in degrees. Takes precedence over the barPadding property. */ barWidth?: number | undefined; /** * An object that defines the series border configuration properties. */ border?: { /** * Sets a border color for a series. */ color?: string | undefined; /** * Specifies a dash style for the borders of series points. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets border visibility for a series. */ visible?: boolean; /** * Sets a border width for a series in pixels. */ width?: number; }; /** * Specifies whether or not to close the chart by joining the end point with the first point. */ closed?: boolean; /** * Specifies a series color. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the dash style of the series' line. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies the series elements to highlight when a series is hovered over. */ hoverMode?: DevExpress.common.charts.SeriesHoverMode; /** * An object defining configuration properties for a hovered series. */ hoverStyle?: { /** * An object defining the border properties for a hovered series. */ border?: { /** * Sets a border color for a hovered series. */ color?: string | undefined; /** * Specifies a dash style for the borders of point labels. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets a border visibility for a hovered series. */ visible?: boolean; /** * Sets a border width for a hovered series. */ width?: number; }; /** * Sets a color for a series when it is hovered over. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the dash style for the line in a hovered series. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies the hatching properties to be applied when a series is hovered over. */ hatching?: { /** * Specifies how to apply hatching to highlight the hovered series. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies the opacity of hatching lines. */ opacity?: number; /** * Specifies the distance between hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; }; /** * Specifies whether to lighten the series when a user points to it. */ highlight?: boolean; /** * Specifies the width of a line in a hovered series. */ width?: number; }; /** * Specifies whether the series should ignore null data points. */ ignoreEmptyPoints?: boolean; /** * An object defining the label configuration properties. */ label?: dxPolarChartSeriesTypesCommonPolarChartSeriesLabel; /** * Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed. */ maxLabelCount?: number | undefined; /** * Specifies the minimal length of a displayed bar in pixels. */ minBarSize?: number | undefined; /** * Specifies opacity for a series. */ opacity?: number; /** * An object defining configuration properties for points in line and area series. */ point?: dxPolarChartSeriesTypesCommonPolarChartSeriesPoint; /** * Specifies the series elements to highlight when the series is selected. */ selectionMode?: DevExpress.common.charts.SeriesSelectionMode; /** * An object defining configuration properties for a selected series. */ selectionStyle?: { /** * An object defining the border properties for a selected series. */ border?: { /** * Sets a border color for a selected series. */ color?: string | undefined; /** * Specifies a dash style for the borders of point labels. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Sets border visibility for a selected series. */ visible?: boolean; /** * Sets a border width for a selected series. */ width?: number; }; /** * Sets a color for a series when it is selected. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the dash style for the line in a selected series. */ dashStyle?: DevExpress.common.charts.DashStyle; /** * Specifies the hatching properties to be applied when a series is selected. */ hatching?: { /** * Specifies how to apply hatching to highlight a selected series. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies the opacity of hatching lines. */ opacity?: number; /** * Specifies the distance between hatching lines in pixels. */ step?: number; /** * Specifies the width of hatching lines in pixels. */ width?: number; }; /** * Specifies whether to lighten the series when a user selects it. */ highlight?: boolean; /** * Specifies the width of a line in a selected series. */ width?: number; }; /** * Specifies whether or not to show the series in the chart's legend. */ showInLegend?: boolean; /** * Specifies the name of the stack where the values of the 'stackedBar' series must be located. */ stack?: string; /** * Specifies the name of the data source field that provides data about a point. */ tagField?: string; /** * Configures error bars. */ valueErrorBar?: { /** * Specifies the color of error bars. */ color?: string; /** * Specifies whether error bars must be displayed in full or partially. */ displayMode?: DevExpress.common.charts.ValueErrorBarDisplayMode; /** * Specifies the length of the lines that indicate error bar edges. */ edgeLength?: number; /** * Specifies the data field that provides data for high error values. */ highValueField?: string | undefined; /** * Specifies the width of the error bar line. */ lineWidth?: number; /** * Specifies the data field that provides data for low error values. */ lowValueField?: string | undefined; /** * Specifies the opacity of error bars. */ opacity?: number | undefined; /** * Specifies how error bar values must be calculated. */ type?: DevExpress.common.charts.ValueErrorBarType | undefined; /** * Specifies the value to be used for generating error bars. */ value?: number; }; /** * Specifies the data source field that provides values for series points. */ valueField?: string; /** * Specifies the visibility of a series. */ visible?: boolean; /** * Specifies a line width. */ width?: number; } /** * @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 dxPolarChartSeriesTypesCommonPolarChartSeriesLabel { /** * Formats the point argument before it is displayed in the point label. To format the point value, use the format property. */ argumentFormat?: DevExpress.common.core.localization.Format | undefined; /** * Colors the point labels' background. The default color is inherited from the points. */ backgroundColor?: string | undefined; /** * Specifies border properties for point labels. */ border?: { /** * Specifies a border color for point labels. */ color?: string | undefined; /** * Specifies a dash style for the borders of point labels. */ dashStyle?: DevExpress.common.charts.DashStyle | undefined; /** * Indicates whether borders are visible in point labels. */ visible?: boolean; /** * Specifies the border width for point labels. */ width?: number; }; /** * Specifies connector properties for series point labels. */ connector?: { /** * Specifies the color of label connectors. */ color?: string | undefined; /** * Indicates whether or not label connectors are visible. */ visible?: boolean; /** * Specifies the width of label connectors. */ width?: number; }; /** * Specifies a callback function that returns the text to be displayed by point labels. */ customizeText?: (pointInfo: any) => string; /** * Specifies font properties for the text displayed in point labels. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a point label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies a label position in bar-like series. */ position?: DevExpress.common.charts.RelativePosition; /** * Specifies the angle used to rotate point labels from their initial position. */ rotationAngle?: number; /** * Specifies whether or not to show a label when the point has a zero value. */ showForZeroValues?: boolean; /** * Specifies the visibility of point labels. */ visible?: boolean; /** * Specifies the label's text. */ displayFormat?: string | undefined; } /** * @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 dxPolarChartSeriesTypesCommonPolarChartSeriesPoint { /** * Specifies border properties for points in the line and area series. */ border?: { /** * Sets a border color for points in the line and area series. */ color?: string | undefined; /** * Sets border visibility for points in the line and area series. */ visible?: boolean; /** * Sets a border width for points in the line or area series. */ width?: number; }; /** * Specifies the points color. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies what series points to highlight when a point is hovered over. */ hoverMode?: DevExpress.common.charts.PointInteractionMode; /** * An object defining configuration properties for a hovered point. */ hoverStyle?: { /** * An object defining the border properties for a hovered point. */ border?: { /** * Sets a border color for a hovered point. */ color?: string | undefined; /** * Sets border visibility for a hovered point. */ visible?: boolean; /** * Sets a border width for a hovered point. */ width?: number; }; /** * Sets a color for a point when it is hovered over. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance). */ size?: number; }; /** * An object specifying the parameters of an image that is used as a point marker. */ image?: | string | undefined | { /** * Specifies the height of an image that is used as a point marker. */ height?: number; /** * Specifies a URL leading to the image to be used as a point marker. */ url?: string | undefined; /** * Specifies the width of an image that is used as a point marker. */ width?: number; }; /** * Specifies what series points to highlight when a point is selected. */ selectionMode?: DevExpress.common.charts.PointInteractionMode; /** * An object defining configuration properties for a selected point. */ selectionStyle?: { /** * An object defining the border properties for a selected point. */ border?: { /** * Sets a border color for a selected point. */ color?: string | undefined; /** * Sets border visibility for a selected point. */ visible?: boolean; /** * Sets a border width for a selected point. */ width?: number; }; /** * Sets a color for a point when it is selected. */ color?: string | DevExpress.common.charts.ChartsColor | undefined; /** * Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance). */ size?: number; }; /** * Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance). */ size?: number; /** * Specifies a symbol for presenting points of the line and area series. */ symbol?: DevExpress.common.charts.PointSymbol; /** * Specifies the points visibility for a line and area series. */ visible?: 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 interface dxPolarChartSeriesTypesLinepolarseries extends dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies series elements to be highlighted when a user points to the series. */ hoverMode?: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'; /** * Specifies series elements to be highlighted when a user selects the series. */ selectionMode?: 'includePoints' | 'excludePoints' | 'none'; } /** * @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 dxPolarChartSeriesTypesStackedbarpolarseries extends dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies series elements to be highlighted when a user points to the series. */ hoverMode?: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; /** * An object defining the label configuration properties. */ label?: dxPolarChartSeriesTypesStackedbarpolarseriesLabel; /** * Specifies series elements to be highlighted when a user selects the series. */ selectionMode?: | 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'; } /** * @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 dxPolarChartSeriesTypesStackedbarpolarseriesLabel extends dxPolarChartSeriesTypesCommonPolarChartSeriesLabel { /** * Specifies a label position in bar-like series. */ position?: DevExpress.common.charts.RelativePosition; } /** * The RangeSelector is a UI component that allows a user to select a range of values on a scale. */ export class dxRangeSelector extends BaseWidget { getDataSource(): DevExpress.common.data.DataSource; /** * Gets the currently selected range. */ getValue(): Array; render(): void; /** * Redraws the UI component. */ render(skipChartAnimation: boolean): void; /** * Sets the selected range. */ setValue( value: | Array | DevExpress.common.charts.VisualRange ): void; } module dxRangeSelector { export type AxisScale = | 'continuous' | 'discrete' | 'logarithmic' | 'semidiscrete'; export type BackgroundImageLocation = | 'center' | 'centerBottom' | 'centerTop' | 'full' | 'leftBottom' | 'leftCenter' | 'leftTop' | 'rightBottom' | 'rightCenter' | 'rightTop'; export type ChartAxisScale = 'continuous' | 'logarithmic'; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxRangeSelectorOptions; /** * The type of the valueChanged event handler's argument. */ export type ValueChangedEvent = DevExpress.common.core.events.NativeEventInfo< dxRangeSelector, MouseEvent | TouchEvent > & { /** * */ readonly value: Array; /** * */ readonly previousValue: Array; }; } /** * * @deprecated * @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 dxRangeSelectorOptions extends BaseWidgetOptions { /** * Specifies the properties for the range selector's background. */ background?: { /** * Specifies the background color for the RangeSelector. */ color?: string; /** * Specifies image properties. */ image?: { /** * Specifies a location for the image in the background of a range selector. */ location?: DevExpress.viz.dxRangeSelector.BackgroundImageLocation; /** * Specifies the image's URL. */ url?: string | undefined; }; /** * Indicates whether or not the background (background color and/or image) is visible. */ visible?: boolean; }; /** * Specifies the RangeSelector's behavior properties. */ behavior?: { /** * Indicates whether or not you can swap sliders. */ allowSlidersSwap?: boolean; /** * Indicates whether or not animation is enabled. */ animationEnabled?: boolean; /** * Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ manualRangeSelectionEnabled?: boolean; /** * Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ moveSelectedRangeByClick?: boolean; /** * Indicates whether to snap a slider to ticks. */ snapToTicks?: boolean; /** * Specifies when to change the component's value. */ valueChangeMode?: DevExpress.common.SliderValueChangeMode; }; /** * Specifies the properties required to display a chart as the range selector's background. */ chart?: { /** * Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. */ barGroupPadding?: number; /** * Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property. */ barGroupWidth?: number | undefined; /** * Specifies an indent from the background's bottom to the lowest chart point. Accepts values from 0 to 1. */ bottomIndent?: number; /** * An object defining the common configuration properties for the chart's series. */ commonSeriesSettings?: DevExpress.viz.dxChart.dxChartCommonSeriesSettings; /** * An object providing properties for managing data from a data source. */ dataPrepareSettings?: { /** * Specifies whether or not to validate values from a data source. */ checkTypeForAllData?: boolean; /** * Specifies whether or not to convert the values from a data source into the data type of an axis. */ convertToAxisDataType?: boolean; /** * Specifies how to sort series points. */ sortingMethod?: | boolean | (( a: { arg?: Date | number | string; val?: Date | number | string }, b: { arg?: Date | number | string; val?: Date | number | string } ) => number); }; /** * Specifies a coefficient that determines the diameter of the largest bubble. */ maxBubbleSize?: number; /** * Specifies the diameter of the smallest bubble measured in pixels. */ minBubbleSize?: number; /** * Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. */ negativesAsZeroes?: boolean; /** * Sets the palette to be used to colorize series in the chart. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of series in the chart. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * An object defining the chart's series. */ series?: ChartSeries | Array | undefined; /** * Defines properties for the series template. */ seriesTemplate?: { /** * Specifies a callback function that returns a series object with individual series settings. */ customizeSeries?: (seriesName: any) => ChartSeries; /** * Specifies a data source field that represents the series name. */ nameField?: string; }; /** * Specifies an indent from the background's top to the topmost chart point. Accepts values from 0 to 1. */ topIndent?: number; /** * Configures the chart value axis. */ valueAxis?: { /** * Indicates whether or not the chart's value axis must be inverted. */ inverted?: boolean; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ logarithmBase?: number; /** * Specifies the maximum value of the chart's value axis. */ max?: number | undefined; /** * Specifies the minimum value of the chart's value axis. */ min?: number | undefined; /** * Specifies the type of the value axis. */ type?: DevExpress.viz.dxRangeSelector.ChartAxisScale | undefined; /** * Specifies the desired type of axis values. */ valueType?: DevExpress.common.charts.ChartsDataType | undefined; }; }; /** * Specifies the color of the parent page element. */ containerBackgroundColor?: string; /** * Specifies a data source for the scale values and for the chart at the background. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies the data source field that provides data for the scale. */ dataSourceField?: string; /** * Range selector's indent properties. */ indent?: { /** * Specifies range selector's left indent. */ left?: number | undefined; /** * Specifies range selector's right indent. */ right?: number | undefined; }; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: ( e: DevExpress.viz.dxRangeSelector.ValueChangedEvent ) => void; /** * Specifies properties of the range selector's scale. */ scale?: { /** * Specifies the length of aggregation intervals in pixels. May be ignored in favor of the aggregationInterval property. */ aggregationGroupWidth?: number | undefined; /** * Specifies the length of aggregation intervals in scale units. Applies only to the scale of the continuous or logarithmic type. */ aggregationInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels. */ discreteAxisDivisionMode?: DevExpress.common.charts.DiscreteAxisDivisionMode; /** * Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only. */ allowDecimals?: boolean | undefined; /** * Configures the scale breaks' appearance. */ breakStyle?: { /** * Specifies the scale breaks' color. */ color?: string; /** * Specifies the scale breaks' line style. */ line?: DevExpress.common.charts.ScaleBreakLineStyle; /** * Specifies the scale breaks' width in pixels. */ width?: number; }; /** * Declares a scale break collection. Applies only if the scale's type is 'continuous' or 'logarithmic'. */ breaks?: Array; /** * Specifies the order of arguments on a discrete scale. */ categories?: Array; /** * Specifies whether to force the scale to start and end on ticks. */ endOnTick?: boolean; /** * Specifies the scale's end value. */ endValue?: number | Date | string | undefined; /** * Days to be excluded from the scale when workdaysOnly is true. */ holidays?: Array | Array; /** * Specifies common properties for scale labels. */ label?: { /** * Specifies a callback function that returns the text to be displayed in scale labels. */ customizeText?: (scaleValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Specifies font properties for the text displayed in the range selector's scale labels. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a scale label. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Decides how to arrange scale labels when there is not enough space to keep all of them. */ overlappingBehavior?: DevExpress.common.charts.LabelOverlap; /** * Specifies a spacing between scale labels and the background bottom edge. */ topIndent?: number; /** * Specifies whether or not the scale's labels are visible. */ visible?: boolean; }; /** * Specifies a value used to calculate the range on a logarithmic scale within which the scale should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ logarithmBase?: number; /** * Specifies properties for the date-time scale's markers. */ marker?: { /** * Defines the properties that can be set for the text that is displayed by the scale markers. */ label?: { /** * Specifies a callback function that returns the text to be displayed in scale markers. */ customizeText?: (markerValue: { value?: Date | number; valueText?: string; }) => string; /** * Formats a value before it is displayed in a scale marker. */ format?: DevExpress.common.core.localization.Format | undefined; }; /** * Specifies the height of the marker's separator. */ separatorHeight?: number; /** * Specifies the space between the marker label and the marker separator. */ textLeftIndent?: number; /** * Specifies the space between the marker's label and the top edge of the marker's separator. */ textTopIndent?: number; /** * Specified the indent between the marker and the scale labels. */ topIndent?: number; /** * Indicates whether scale markers are visible. */ visible?: boolean; }; /** * Specifies the maximum range that can be selected. */ maxRange?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the minimum range that can be selected. */ minRange?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies properties of the range selector's minor ticks. */ minorTick?: { /** * Specifies the color of the scale's minor ticks. */ color?: string; /** * Specifies the opacity of the scale's minor ticks. */ opacity?: number; /** * Indicates whether scale minor ticks are visible or not. */ visible?: boolean; /** * Specifies the width of the scale's minor ticks. */ width?: number; }; /** * Specifies the number of minor ticks between neighboring major ticks. */ minorTickCount?: number | undefined; /** * Specifies an interval between minor ticks. */ minorTickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the height of the space reserved for the scale in pixels. */ placeholderHeight?: number | undefined; /** * Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ showCustomBoundaryTicks?: boolean; /** * Days to be included in the scale when workdaysOnly is true. */ singleWorkdays?: Array | Array; /** * Specifies the scale's start value. */ startValue?: number | Date | string | undefined; /** * Specifies properties defining the appearance of scale ticks. */ tick?: { /** * Specifies the color of scale ticks (major ticks only). */ color?: string; /** * Specifies the opacity of scale ticks (major ticks only). */ opacity?: number; /** * Specifies the width of the scale's ticks (major ticks only). */ width?: number; }; /** * Specifies an interval between axis ticks. */ tickInterval?: DevExpress.common.charts.TimeIntervalConfig; /** * Specifies the type of the scale. */ type?: DevExpress.viz.dxRangeSelector.AxisScale | undefined; /** * Specifies the type of values on the scale. */ valueType?: DevExpress.common.charts.ChartsDataType | undefined; /** * Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true. */ workWeek?: Array; /** * Leaves only workdays on the scale: the work week days plus single workdays minus holidays. Applies only if the scale's valueType is 'datetime'. */ workdaysOnly?: boolean; }; /** * Specifies the color of the selected range. */ selectedRangeColor?: string; /** * Specifies how the selected range should behave when data is updated. Applies only when the RangeSelector is bound to a data source. */ selectedRangeUpdateMode?: DevExpress.common.charts.VisualRangeUpdateMode; /** * Specifies range selector shutter properties. */ shutter?: { /** * Specifies shutter color. */ color?: string | undefined; /** * Specifies the opacity of the color of shutters. */ opacity?: number; }; /** * Specifies the appearance of the range selector's slider handles. */ sliderHandle?: { /** * Specifies the color of the slider handles. */ color?: string; /** * Specifies the opacity of the slider handles. */ opacity?: number; /** * Specifies the width of the slider handles. */ width?: number; }; /** * Defines the properties of the range selector slider markers. */ sliderMarker?: { /** * Specifies the color of the slider markers. */ color?: string; /** * Specifies a callback function that returns the text to be displayed by slider markers. */ customizeText?: (scaleValue: { value?: Date | number | string; valueText?: string; }) => string; /** * Specifies font properties for the text displayed by the range selector slider markers. */ font?: DevExpress.common.charts.Font; /** * Formats a value before it is displayed in a slider marker. */ format?: DevExpress.common.core.localization.Format | undefined; /** * Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ invalidRangeColor?: string; /** * Specifies the empty space between the marker's left and right borders and the marker's text. */ paddingLeftRight?: number; /** * Specifies the empty space between the marker's top and bottom borders and the marker's text. */ paddingTopBottom?: number; /** * Specifies the placeholder height of the slider marker. */ placeholderHeight?: number | undefined; /** * Indicates whether or not the slider markers are visible. */ visible?: boolean; }; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: BaseWidgetTooltip; /** * The selected range (initial or current). Equals the entire scale when not set. */ value?: | Array | DevExpress.common.charts.VisualRange; } /** * The Sankey is a UI component that visualizes the flow magnitude between value sets. The values being connected are called nodes; the connections - links. The higher the flow magnitude, the wider the link is. */ export class dxSankey extends BaseWidget { /** * Gets all sankey links. */ getAllLinks(): Array; /** * Gets all sankey nodes. */ getAllNodes(): Array; getDataSource(): DevExpress.common.data.DataSource; /** * Hides all UI component tooltips. */ hideTooltip(): void; } module dxSankey { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the linkClick event handler's argument. */ export type LinkClickEvent = DevExpress.common.core.events.NativeEventInfo< dxSankey, MouseEvent | PointerEvent > & { /** * */ readonly target: dxSankeyLink; }; /** * The type of the linkHoverChanged event handler's argument. */ export type LinkHoverEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly target: dxSankeyLink; }; /** * The type of the nodeClick event handler's argument. */ export type NodeClickEvent = DevExpress.common.core.events.NativeEventInfo< dxSankey, MouseEvent | PointerEvent > & { /** * */ readonly target: dxSankeyNode; }; /** * The type of the nodeHoverChanged event handler's argument. */ export type NodeHoverEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly target: dxSankeyNode; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSankeyOptions; export type SankeyColorMode = 'none' | 'source' | 'target' | 'gradient'; /** * */ export type Tooltip = BaseWidgetTooltip & { /** * Customizes link tooltips' appearance. */ customizeLinkTooltip?: | ((info: { source?: string; target?: string; weight?: number }) => any) | undefined; /** * Customizes node tooltips' appearance. */ customizeNodeTooltip?: | ((info: { title?: string; label?: string; weightIn?: number; weightOut?: number; }) => any) | undefined; /** * Specifies whether the tooltip is enabled. */ enabled?: boolean; /** * Specifies a custom template for a link's tooltip. */ linkTooltipTemplate?: | template | (( info: { source?: string; target?: string; weight?: number }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies a custom template for a node's tooltip. */ nodeTooltipTemplate?: | template | (( info: { label?: string; weightIn?: number; weightOut?: number }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; }; } /** * * @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 dxSankeyConnectionInfoObject { /** * The title of the link's source node. */ source?: string; /** * The title of the link's target node. */ target?: string; /** * The link's weight. */ weight?: number; } /** * A sankey link's structure. * @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 dxSankeyLink { /** * An object that describes the connection. */ connection?: dxSankeyConnectionInfoObject; /** * Hides the sankey link's tooltip. */ hideTooltip(): void; /** * Changes the sankey link's hover state. */ hover(state: boolean): void; /** * Indicates whether the sankey link is in the hover state. */ isHovered(): boolean; /** * Shows the sankey link's tooltip. */ showTooltip(): void; } /** * A sankey node's structure. * @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 dxSankeyNode { /** * Hides the sankey node's tooltip. */ hideTooltip(): void; /** * Changes the sankey node's hover state. */ hover(state: boolean): void; /** * Indicates whether the sankey node is in the hover state. */ isHovered(): boolean; /** * The node's label. */ label?: string; /** * The node's incoming links. */ linksIn?: Array; /** * The node's outgoing links. */ linksOut?: Array; /** * Shows the sankey node's tooltip. */ showTooltip(): void; } /** * * @deprecated * @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 dxSankeyOptions extends BaseWidgetOptions { /** * Specifies adaptive layout properties. */ adaptiveLayout?: { /** * Specifies the minimum container height at which the layout begins to adapt. */ height?: number; /** * Specifies whether node labels should be kept when the UI component adapts the layout. */ keepLabels?: boolean; /** * Specifies the minimum container width at which the layout begins to adapt. */ width?: number; }; /** * Aligns node columns vertically. */ alignment?: | DevExpress.common.VerticalAlignment | Array; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Specifies whether nodes and links change their style when they are hovered over or pressed. */ hoverEnabled?: boolean; /** * Configures sankey nodes' labels. */ label?: { /** * Configures the labels' borders. */ border?: { /** * Colors the labels' borders. */ color?: string | undefined; /** * Specifies whether the borders are visible. */ visible?: boolean | undefined; /** * Sets the borders' width in pixels. */ width?: number | undefined; }; /** * Customizes the labels' texts. */ customizeText?: (itemInfo: dxSankeyNode) => string; /** * Specifies the labels' font properties. */ font?: DevExpress.common.charts.Font; /** * Moves the labels horizontally from their initial positions. */ horizontalOffset?: number; /** * Specifies how to arrange labels when there is insufficient space to display them all. */ overlappingBehavior?: DevExpress.common.charts.TextOverflow; /** * Configures the labels' shadows. */ shadow?: { /** * Specifies the shadows' blur distance. A larger value increases the blur distance. */ blur?: number; /** * Colors the labels' shadows. */ color?: string; /** * Moves the shadows horizontally from their initial positions. */ offsetX?: number; /** * Moves the shadows vertically from their initial positions. */ offsetY?: number; /** * Specifies the shadows' transparency. */ opacity?: number; }; /** * Specifies whether to color labels in the nodes' colors. */ useNodeColors?: boolean; /** * Moves the labels vertically from their initial positions. */ verticalOffset?: number; /** * Specifies whether the labels are visible. */ visible?: boolean; }; /** * Configures sankey links' appearance. */ link?: { /** * Configures the links' borders. */ border?: { /** * Colors the links' borders. */ color?: string | undefined; /** * Specifies whether the borders are visible. */ visible?: boolean | undefined; /** * Sets the borders' width in pixels. */ width?: number | undefined; }; /** * Colors the sankey links. Applies only if colorMode is 'none'. */ color?: string; /** * Specifies how to color links. */ colorMode?: DevExpress.viz.dxSankey.SankeyColorMode; /** * Configures the appearance a link changes to when it is hovered over or pressed. */ hoverStyle?: { /** * Configures the appearance a link's border changes to when the link is hovered over or pressed. */ border?: { /** * Specifies the color a link's border changes to when the link is hovered over or pressed. */ color?: string | undefined; /** * Specifies whether a link's border is visible when the link is hovered over or pressed. */ visible?: boolean | undefined; /** * Specifies the width a link's border changes to when the link is hovered over or pressed. */ width?: number | undefined; }; /** * Specifies the color a link changes to when it is hovered over or pressed. */ color?: string | undefined; /** * Applies hatching to a link when it is hovered over or pressed. */ hatching?: { /** * Specifies hatching lines' direction. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies hatching lines' transparency. */ opacity?: number; /** * Specifies the distance in pixels between two hatching lines. */ step?: number; /** * Specifies hatching lines' width. */ width?: number; }; /** * Specifies the transparency a link changes to when it is hovered over or pressed. */ opacity?: number | undefined; }; /** * Specifies the links' transparency. */ opacity?: number; }; /** * Configures sankey nodes' appearance. */ node?: { /** * Configures the nodes' borders. */ border?: { /** * Colors the nodes' borders. */ color?: string | undefined; /** * Specifies whether the borders are visible. */ visible?: boolean | undefined; /** * Sets the borders' width in pixels. */ width?: number | undefined; }; /** * Colors the sankey nodes. */ color?: string | undefined; /** * Configures the appearance a node changes to when it is hovered over or pressed. */ hoverStyle?: { /** * Configures the appearance a node's border changes to when the node is hovered over or pressed. */ border?: { /** * Specifies the color a node's border changes to when the node is hovered over or pressed. */ color?: string | undefined; /** * Specifies whether a node's border is visible when the node is hovered over or pressed. */ visible?: boolean | undefined; /** * Specifies the width a node's border changes to when the node is hovered over or pressed. */ width?: number | undefined; }; /** * Specifies the color a node changes to when it is hovered over or pressed. */ color?: string | undefined; /** * Applies hatching to a node when it is hovered over or pressed. */ hatching?: { /** * Specifies hatching lines' direction. */ direction?: DevExpress.common.charts.HatchDirection; /** * Specifies hatching lines' transparency. */ opacity?: number; /** * Specifies the distance in pixels between two hatching lines. */ step?: number; /** * Specifies hatching lines' width. */ width?: number; }; /** * Specifies the transparency a node changes to when it is hovered over or pressed. */ opacity?: number | undefined; }; /** * Specifies the nodes' transparency. */ opacity?: number; /** * Specifies the vertical distance, in pixels, between two nodes. */ padding?: number; /** * Specifies the nodes' width in pixels. */ width?: number; }; /** * A function that is executed when a sankey link is clicked or tapped. */ onLinkClick?: | ((e: DevExpress.viz.dxSankey.LinkClickEvent) => void) | string; /** * A function that is executed after the pointer enters or leaves a sankey link. */ onLinkHoverChanged?: (e: DevExpress.viz.dxSankey.LinkHoverEvent) => void; /** * A function that is executed when a sankey node is clicked or tapped. */ onNodeClick?: | ((e: DevExpress.viz.dxSankey.NodeClickEvent) => void) | string; /** * A function that is executed after the pointer enters or leaves a sankey node. */ onNodeHoverChanged?: (e: DevExpress.viz.dxSankey.NodeHoverEvent) => void; /** * Sets the palette to be used to colorize sankey nodes. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies how to extend the palette when it contains less colors than the number of sankey nodes. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * Specifies nodes' sorting order in their columns. */ sortData?: any | undefined; /** * Specifies which data source field provides links' source nodes. */ sourceField?: string; /** * Specifies which data source field provides links' target nodes. */ targetField?: string; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: DevExpress.viz.dxSankey.Tooltip; /** * Specifies which data source field provides links' weights. */ weightField?: string; } /** * The Sparkline UI component is a compact chart that contains only one series. Owing to their size, sparklines occupy very little space and can be easily collected in a table or embedded straight in text. */ export class dxSparkline extends BaseSparkline { getDataSource(): DevExpress.common.data.DataSource; } module dxSparkline { /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxSparklineOptions; export type SparklineType = | 'area' | 'bar' | 'line' | 'spline' | 'splinearea' | 'steparea' | 'stepline' | 'winloss'; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo; /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo; } /** * * @deprecated * @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 dxSparklineOptions extends BaseSparklineOptions { /** * Specifies the data source field that provides arguments for a sparkline. */ argumentField?: string; /** * Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. */ barNegativeColor?: string; /** * Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. */ barPositiveColor?: string; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Sets a color for the boundary of both the first and last points on a sparkline. */ firstLastColor?: string; /** * Specifies whether the sparkline should ignore null data points. */ ignoreEmptyPoints?: boolean; /** * Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ lineColor?: string; /** * Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. */ lineWidth?: number; /** * Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. */ lossColor?: string; /** * Sets a color for the boundary of the maximum point on a sparkline. */ maxColor?: string; /** * Specifies the maximum value of the sparkline's value axis. */ maxValue?: number | undefined; /** * Sets a color for the boundary of the minimum point on a sparkline. */ minColor?: string; /** * Specifies the minimum value of the sparkline value axis. */ minValue?: number | undefined; /** * Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. */ pointColor?: string; /** * Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. */ pointSize?: number; /** * Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. */ pointSymbol?: DevExpress.common.charts.PointSymbol; /** * Specifies whether or not to indicate both the first and last values on a sparkline. */ showFirstLast?: boolean; /** * Specifies whether or not to indicate both the minimum and maximum values on a sparkline. */ showMinMax?: boolean; /** * Determines the type of a sparkline. */ type?: DevExpress.viz.dxSparkline.SparklineType; /** * Specifies the data source field that provides values for a sparkline. */ valueField?: string; /** * Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. */ winColor?: string; /** * Specifies a value that serves as a threshold for the sparkline of the winloss type. */ winlossThreshold?: number; } /** * The TreeMap is a UI component that displays hierarchical data by using nested rectangles. */ export class dxTreeMap extends BaseWidget { /** * Deselects all nodes in the UI component. */ clearSelection(): void; /** * Drills one level up. */ drillUp(): void; /** * Gets the current node. */ getCurrentNode(): dxTreeMapNode; getDataSource(): DevExpress.common.data.DataSource; /** * Gets the root node. */ getRootNode(): dxTreeMapNode; /** * Hides the tooltip. */ hideTooltip(): void; /** * Resets the drill down level. */ resetDrillDown(): void; } module dxTreeMap { /** * The type of the click event handler's argument. */ export type ClickEvent = DevExpress.common.core.events.NativeEventInfo< dxTreeMap, MouseEvent | PointerEvent > & { /** * */ readonly node: dxTreeMapNode; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drill event handler's argument. */ export type DrillEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly node: dxTreeMapNode; }; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the hoverChanged event handler's argument. */ export type HoverChangedEvent = DevExpress.common.core.events.EventInfo & InteractionInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * * @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 InteractionInfo { /** * */ readonly node: dxTreeMapNode; } /** * The type of the nodesInitialized event handler's argument. */ export type NodesInitializedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly root: dxTreeMapNode; }; /** * The type of the nodesRendering event handler's argument. */ export type NodesRenderingEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly node: dxTreeMapNode; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxTreeMapOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & InteractionInfo; /** * */ export type Tooltip = BaseWidgetTooltip & { /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( info: { value?: number; valueText?: string; node?: dxTreeMapNode }, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Allows you to change tooltip appearance. */ customizeTooltip?: | ((info: { value?: number; valueText?: string; node?: dxTreeMapNode; }) => any) | undefined; }; export type TreeMapColorizerType = | 'discrete' | 'gradient' | 'none' | 'range'; export type TreeMapLayoutAlgorithm = | 'sliceanddice' | 'squarified' | 'strip'; export type TreeMapLayoutDirection = | 'leftBottomRightTop' | 'leftTopRightBottom' | 'rightBottomLeftTop' | 'rightTopLeftBottom'; } /** * This section describes the node object. * @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 dxTreeMapNode { /** * Customizes the node. */ customize(options: any): void; /** * The object from the data source visualized by the node. */ data?: any; /** * Drills down into the node. */ drillDown(): void; /** * Returns all nodes nested in the current node. */ getAllChildren(): Array; /** * Returns all descendant nodes. */ getAllNodes(): Array; /** * Gets a specific node from a collection of direct descendants. */ getChild(index: number): dxTreeMapNode; /** * Indicates how many direct descendants the current node has. */ getChildrenCount(): number; /** * Returns the parent node of the current node. */ getParent(): dxTreeMapNode; /** * The index of the current node in the array of all nodes on the same level. */ index?: number; /** * Indicates whether the current node is active. */ isActive(): boolean; /** * Indicates whether the node is in the hover state or not. */ isHovered(): boolean; /** * Indicates whether the node is visualized by a tile or a group of tiles. */ isLeaf(): boolean; /** * Indicates whether the node is selected or not. */ isSelected(): boolean; /** * Returns the label of the node. */ label(): string; /** * Sets the label to the node. */ label(label: string): void; /** * The level that the current node occupies in the hierarchy of nodes. */ level?: number; /** * Reverts the appearance of the node to the initial state. */ resetCustomization(): void; /** * Sets the selection state of a node. */ select(state: boolean): void; /** * Shows the tooltip. */ showTooltip(): void; /** * Gets the raw value of the node. */ value(): number; } /** * * @deprecated * @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 dxTreeMapOptions extends BaseWidgetOptions { /** * Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only. */ childrenField?: string; /** * Specifies the name of the data source field that provides colors for tiles. */ colorField?: string; /** * Manages the color settings. */ colorizer?: { /** * Specifies the name of the data source field whose values define the color of a tile. Applies only if the type property is 'gradient' or 'range'. */ colorCodeField?: string | undefined; /** * Specifies whether or not all tiles in a group must be colored uniformly. Applies only if the type property is 'discrete'. */ colorizeGroups?: boolean; /** * Sets the palette to be used to colorize tiles. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies what to do with colors in the palette when their number is less than the number of treemap tiles. */ paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; /** * Allows you to paint tiles with similar values uniformly. Applies only if the type property is 'gradient' or 'range'. */ range?: Array; /** * Specifies the colorizing algorithm. */ type?: DevExpress.viz.dxTreeMap.TreeMapColorizerType | undefined; }; /** * Binds the UI component to data. */ dataSource?: DevExpress.data.DataSourceLike | null; /** * Configures groups. */ group?: { /** * Configures the group borders. */ border?: { /** * Colors the group borders. */ color?: string | undefined; /** * Specifies the width of the group borders in pixels. */ width?: number | undefined; }; /** * Colors the group headers. */ color?: string; /** * Specifies the distance in pixels between group borders and content. */ padding?: number; /** * Specifies the height of the group headers in pixels. */ headerHeight?: number | undefined; /** * Specifies whether groups change their style when a user pauses on them. */ hoverEnabled?: boolean | undefined; /** * Specifies the appearance of groups in the hover state. */ hoverStyle?: { /** * Configures the appearance of the group borders in the hover state. */ border?: { /** * Colors the group borders in the hover state. */ color?: string | undefined; /** * Specifies the width of the group borders in pixels. Applies to a group in the hover state. */ width?: number | undefined; }; /** * Colors the group headers in the hover state. */ color?: string | undefined; }; /** * Configures the group labels. */ label?: { /** * Specifies the font settings of the group labels. */ font?: DevExpress.common.charts.Font; /** * Specifies what to do with labels that overflow their group headers: hide, truncated them with ellipsis, or leave them as they are. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Changes the visibility of the group labels. */ visible?: boolean; }; /** * Specifies the appearance of groups in the selected state. */ selectionStyle?: { /** * Configures the appearance of the group borders in the selected state. */ border?: { /** * Colors the group borders in the selected state. */ color?: string | undefined; /** * Specifies the width of the group borders in pixels. Applies to a group in the selected state. */ width?: number | undefined; }; /** * Colors the group headers in the selected state. */ color?: string | undefined; }; }; /** * Specifies whether tiles and groups change their style when a user pauses on them. */ hoverEnabled?: boolean | undefined; /** * Specifies the name of the data source field that provides IDs for items. Applies to plain data sources only. */ idField?: string | undefined; /** * Specifies whether the user will interact with a single tile or its group. */ interactWithGroup?: boolean; /** * Specifies the name of the data source field that provides texts for tile and group labels. */ labelField?: string; /** * Specifies the layout algorithm. */ layoutAlgorithm?: | DevExpress.viz.dxTreeMap.TreeMapLayoutAlgorithm | ((e: { rect?: Array; sum?: number; items?: Array; }) => any); /** * Specifies the direction in which the items will be laid out. */ layoutDirection?: DevExpress.viz.dxTreeMap.TreeMapLayoutDirection; /** * Generates space around the UI component. */ margin?: BaseWidgetMargin; /** * Specifies how many hierarchical levels must be visualized. */ maxDepth?: number | undefined; /** * A function that is executed when a node is clicked or tapped. */ onClick?: ((e: DevExpress.viz.dxTreeMap.ClickEvent) => void) | string; /** * A function that is executed when a user drills up or down. */ onDrill?: (e: DevExpress.viz.dxTreeMap.DrillEvent) => void; /** * A function that is executed after the pointer enters or leaves a node. */ onHoverChanged?: (e: DevExpress.viz.dxTreeMap.HoverChangedEvent) => void; /** * A function that is executed only once, after the nodes are initialized. */ onNodesInitialized?: ( e: DevExpress.viz.dxTreeMap.NodesInitializedEvent ) => void; /** * A function that is executed before the nodes are displayed and each time the collection of active nodes is changed. */ onNodesRendering?: ( e: DevExpress.viz.dxTreeMap.NodesRenderingEvent ) => void; /** * A function that is executed when a node is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.viz.dxTreeMap.SelectionChangedEvent ) => void; /** * Specifies the name of the data source field that provides parent IDs for items. Applies to plain data sources only. */ parentField?: string | undefined; /** * Specifies whether a single or multiple nodes can be in the selected state simultaneously. */ selectionMode?: DevExpress.common.SingleMultipleOrNone | undefined; /** * Configures tiles. */ tile?: { /** * Configures the tile borders. */ border?: { /** * Colors the tile borders. */ color?: string | undefined; /** * Specifies the width of the tile borders in pixels. */ width?: number | undefined; }; /** * Specifies a single color for all tiles. */ color?: string; /** * Specifies the appearance of tiles in the hover state. */ hoverStyle?: { /** * Configures the appearance of the tile borders in the hover state. */ border?: { /** * Colors the tile borders in the hover state. */ color?: string | undefined; /** * Specifies the width of the tile borders in pixels. Applies to a tile in the hover state. */ width?: number | undefined; }; /** * Colors tiles in the hover state. */ color?: string | undefined; }; /** * Configures the tile labels. */ label?: { /** * Specifies the font settings of the tile labels. */ font?: DevExpress.common.charts.Font; /** * Specifies what to do with labels that overflow their tiles after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing. */ textOverflow?: DevExpress.common.charts.TextOverflow; /** * Changes the visibility of the tile labels. */ visible?: boolean; /** * Specifies how to wrap texts that do not fit into a single line. */ wordWrap?: DevExpress.common.charts.WordWrap; }; /** * Specifies the appearance of tiles in the selected state. */ selectionStyle?: { /** * Configures the appearance of the tile borders in the selected state. */ border?: { /** * Colors the tile borders in the selected state. */ color?: string | undefined; /** * Specifies the width of the tile borders in pixels. Applies to a tile in the selected state. */ width?: number | undefined; }; /** * Colors tiles in the selected state. */ color?: string | undefined; }; }; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: DevExpress.viz.dxTreeMap.Tooltip; /** * Specifies the name of the data source field that provides values for tiles. */ valueField?: string; } /** * The VectorMap is a UI component that visualizes geographical locations. This UI component represents a geographical map that contains areas and markers. Areas embody continents and countries. Markers flag specific points on the map, for example, towns, cities or capitals. */ export class dxVectorMap extends BaseWidget { /** * Gets the current map center coordinates. */ center(): Array; /** * Sets the map center coordinates. */ center(centerCoordinates: Array): void; /** * Deselects all the selected area and markers on a map at once. The areas and markers are displayed in their initial style after. */ clearSelection(): void; /** * Converts coordinates from pixels to the dataSource coordinate system. */ convertToGeo(x: number, y: number): Array; /** * Converts coordinates from the dataSource coordinate system to pixels. */ convertToXY(longitude: number, latitude: number): Array; /** * Gets a layer with a specific index. */ getLayerByIndex(index: number): MapLayer; /** * Gets a layer with a specific name. */ getLayerByName(name: string): MapLayer; /** * Gets all layers. */ getLayers(): Array; /** * Gets the current map viewport coordinates. */ viewport(): Array; /** * Sets the map viewport coordinates. */ viewport(viewportCoordinates: Array): void; /** * Gets the current zoom factor value. */ zoomFactor(): number; /** * Sets the zoom factor value. */ zoomFactor(zoomFactor: number): void; } module dxVectorMap { /** * The type of the centerChanged event handler's argument. */ export type CenterChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly center: Array; }; /** * The type of the click event handler's argument. */ export type ClickEvent = DevExpress.common.core.events.NativeEventInfo< dxVectorMap, MouseEvent | PointerEvent > & { /** * */ readonly target: MapLayerElement; }; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = DevExpress.common.core.events.EventInfo; /** * The type of the drawn event handler's argument. */ export type DrawnEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exported event handler's argument. */ export type ExportedEvent = DevExpress.common.core.events.EventInfo; /** * The type of the exporting event handler's argument. */ export type ExportingEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.ExportInfo; /** * The type of the fileSaving event handler's argument. */ export type FileSavingEvent = DevExpress.viz.BaseWidget.FileSavingEventInfo; /** * The type of the incidentOccurred event handler's argument. */ export type IncidentOccurredEvent = DevExpress.common.core.events.EventInfo & DevExpress.viz.BaseWidget.IncidentInfo; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = DevExpress.common.core.events.InitializedEventInfo; /** * Configures map legends. */ export type Legend = DevExpress.common.charts.BaseLegend & { /** * Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item. */ customizeHint?: (itemInfo: { start?: number; end?: number; index?: number; color?: string; size?: number; }) => string; /** * Allows you to change the order and visibility of legend items. */ customizeItems?: (items: Array) => Array; /** * Specifies text for legend items. */ customizeText?: (itemInfo: { start?: number; end?: number; index?: number; color?: string; size?: number; }) => string; /** * Specifies the legend items' font properties. */ font?: DevExpress.common.charts.Font; /** * Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source. */ markerColor?: string | undefined; /** * Specifies the shape of item markers. */ markerShape?: VectorMapMarkerShape; /** * Specifies the marker's size in a legend item in pixels. */ markerSize?: number; /** * Specifies an SVG element that serves as a custom legend item marker. */ markerTemplate?: | template | (( legendItem: LegendItem, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies the source of data for the legend. */ source?: { /** * Specifies the type of the legend grouping. */ grouping?: string; /** * Specifies a layer to which the legend belongs. */ layer?: string; }; }; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = DevExpress.common.core.events.EventInfo & DevExpress.common.core.events.ChangedOptionInfo; export type Properties = dxVectorMapOptions; /** * The type of the selectionChanged event handler's argument. */ export type SelectionChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly target: MapLayerElement; }; /** * Configures tooltips. */ export type Tooltip = BaseWidgetTooltip & { /** * Specifies a custom template for a tooltip. */ contentTemplate?: | template | (( info: MapLayerElement, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies text and appearance of a set of tooltips. */ customizeTooltip?: ((info: MapLayerElement) => any) | undefined; /** * */ format?: DevExpress.common.core.localization.Format; }; /** * The type of the tooltipHidden event handler's argument. */ export type TooltipHiddenEvent = DevExpress.common.core.events.EventInfo & TooltipInfo; /** * * @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 TooltipInfo { /** * */ target?: MapLayerElement | dxVectorMapAnnotationConfig; } /** * The type of the tooltipShown event handler's argument. */ export type TooltipShownEvent = DevExpress.common.core.events.EventInfo & TooltipInfo; export type VectorMapLayerType = 'area' | 'line' | 'marker'; export type VectorMapMarkerShape = 'circle' | 'square'; export type VectorMapMarkerType = 'bubble' | 'dot' | 'image' | 'pie'; /** * The type of the zoomFactorChanged event handler's argument. */ export type ZoomFactorChangedEvent = DevExpress.common.core.events.EventInfo & { /** * */ readonly zoomFactor: number; }; } /** * * @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 dxVectorMapAnnotationConfig extends dxVectorMapCommonAnnotationConfig { /** * Specifies the annotation's name. */ name?: string | undefined; } /** * * @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 dxVectorMapCommonAnnotationConfig extends BaseWidgetAnnotationConfig { /** * Positions the annotation's center at specified geographic coordinates: [longitude, latitude]. */ coordinates?: Array; /** * Customizes the text and appearance of the annotation's tooltip. */ customizeTooltip?: | ((annotation: dxVectorMapAnnotationConfig | any) => any) | undefined; /** * Specifies a custom template for the annotation. Applies only if the type is 'custom'. */ template?: | template | (( annotation: dxVectorMapAnnotationConfig | any, element: SVGGElement ) => string | DevExpress.core.UserDefinedElement) | undefined; /** * Specifies a custom template for an annotation's tooltip. */ tooltipTemplate?: | template | (( annotation: dxVectorMapAnnotationConfig | any, element: DevExpress.core.DxElement ) => string | DevExpress.core.UserDefinedElement) | undefined; } /** * * @deprecated * @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 dxVectorMapOptions extends BaseWidgetOptions { /** * Specifies the properties for the map background. */ background?: { /** * Specifies a color for the background border. */ borderColor?: string; /** * Specifies a color for the background. */ color?: string; }; /** * Specifies the positioning of a map in geographical coordinates. */ bounds?: Array; /** * Specifies the geographical coordinates of the center for a map. */ center?: Array; /** * Configures the control bar. */ controlBar?: { /** * Specifies a color for the outline of the control bar elements. */ borderColor?: string; /** * Specifies a color for the inner area of the control bar elements. */ color?: string; /** * Specifies whether or not to display the control bar. */ enabled?: boolean; /** * Specifies whether the pan control is visible. */ panVisible?: boolean; /** * Specifies whether the zoom bar is visible. */ zoomVisible?: boolean; /** * Specifies the position of the control bar. */ horizontalAlignment?: DevExpress.common.HorizontalAlignment; /** * Specifies the margin of the control bar in pixels. */ margin?: number; /** * Specifies the opacity of the control bar. */ opacity?: number; /** * Specifies the position of the control bar. */ verticalAlignment?: DevExpress.common.VerticalEdge; }; /** * Specifies properties for VectorMap UI component layers. */ layers?: | Array<{ /** * Specifies a color for the border of the layer elements. */ borderColor?: string; /** * Specifies the line width (for layers of a line type) or width of the layer elements border in pixels. */ borderWidth?: number; /** * Specifies a color for layer elements. */ color?: string; /** * Specifies the field that provides data to be used for coloring of layer elements. */ colorGroupingField?: string | undefined; /** * Allows you to paint layer elements with similar attributes in the same color. */ colorGroups?: Array; /** * A function that customizes each layer element individually. */ customize?: (elements: Array) => void; /** * Specifies the name of the attribute containing marker data. Setting this property makes sense only if the layer type is 'marker' and the elementType is 'bubble', 'pie' or 'image'. */ dataField?: string | undefined; /** * Specifies a data source for the layer. */ dataSource?: object | DevExpress.data.DataSourceLike | null; /** * Specifies the type of a marker element. Setting this property makes sense only if the layer type is 'marker'. */ elementType?: DevExpress.viz.dxVectorMap.VectorMapMarkerType; /** * Specifies whether or not to change the appearance of a layer element when it is hovered over. */ hoverEnabled?: boolean; /** * Specifies a color for the border of the layer element when it is hovered over. */ hoveredBorderColor?: string; /** * Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over. */ hoveredBorderWidth?: number; /** * Specifies a color for a layer element when it is hovered over. */ hoveredColor?: string; /** * Specifies marker label properties. */ label?: { /** * The name of the data source attribute containing marker texts. */ dataField?: string; /** * Enables marker labels. */ enabled?: boolean; /** * Specifies font properties for marker labels. */ font?: DevExpress.common.charts.Font; }; /** * Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this property makes sense only if the layer type is 'marker'. */ maxSize?: number; /** * Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this property makes sense only if the layer type is 'marker'. */ minSize?: number; /** * Specifies the layer name. */ name?: string; /** * Specifies the layer opacity (from 0 to 1). */ opacity?: number; /** * The name of a predefined palette or a custom range of colors to be used as a palette. */ palette?: Array | DevExpress.common.charts.Palette; /** * Specifies the number of colors in a palette. */ paletteSize?: number; /** * The position of a color in the palette[] array. Should not exceed the value of the paletteSize property. */ paletteIndex?: number; /** * Specifies a color for the border of the layer element when it is selected. */ selectedBorderColor?: string; /** * Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected. */ selectedBorderWidth?: number; /** * Specifies a color for the layer element when it is selected. */ selectedColor?: string; /** * Specifies whether single or multiple map elements can be selected on a vector map. */ selectionMode?: DevExpress.common.SingleMultipleOrNone; /** * Specifies the size of markers. Setting this property makes sense only if the layer type is 'marker' and the elementType is 'dot', 'pie' or 'image'. */ size?: number; /** * Specifies the field that provides data to be used for sizing bubble markers. Setting this property makes sense only if the layer type is 'marker' and the elementType is 'bubble'. */ sizeGroupingField?: string | undefined; /** * Allows you to display bubbles with similar attributes in the same size. Setting this property makes sense only if the layer type is 'marker' and the elementType is 'bubble'. */ sizeGroups?: Array; /** * Specifies layer type. */ type?: DevExpress.viz.dxVectorMap.VectorMapLayerType; }> | { borderColor?: string; borderWidth?: number; color?: string; colorGroupingField?: string; colorGroups?: Array; customize?: (elements: Array) => any; dataField?: string; dataSource?: object | DevExpress.data.DataSourceLike | null; elementType?: 'bubble' | 'dot' | 'image' | 'pie'; hoverEnabled?: boolean; hoveredBorderColor?: string; hoveredBorderWidth?: number; hoveredColor?: string; label?: { dataField?: string; enabled?: boolean; font?: DevExpress.common.charts.Font; }; maxSize?: number; minSize?: number; name?: string; opacity?: number; palette?: Array | DevExpress.common.charts.Palette; paletteSize?: number; selectedBorderColor?: string; selectedBorderWidth?: number; selectedColor?: string; selectionMode?: DevExpress.common.SingleMultipleOrNone; size?: number; sizeGroupingField?: string; sizeGroups?: Array; type?: 'area' | 'line' | 'marker'; }; /** * Configures map legends. */ legends?: Array | undefined; /** * Generates space around the UI component. */ margin?: BaseWidgetMargin; /** * Specifies a map's maximum zoom factor. */ maxZoomFactor?: number; /** * A function that is executed each time the center coordinates are changed. */ onCenterChanged?: ( e: DevExpress.viz.dxVectorMap.CenterChangedEvent ) => void; /** * A function that is executed when any location on the map is clicked or tapped. */ onClick?: ((e: DevExpress.viz.dxVectorMap.ClickEvent) => void) | string; /** * A function that is executed when a layer element is selected or selection is canceled. */ onSelectionChanged?: ( e: DevExpress.viz.dxVectorMap.SelectionChangedEvent ) => void; /** * A function that is executed when a tooltip becomes hidden. */ onTooltipHidden?: ( e: DevExpress.viz.dxVectorMap.TooltipHiddenEvent ) => void; /** * A function that is executed when a tooltip appears. */ onTooltipShown?: (e: DevExpress.viz.dxVectorMap.TooltipShownEvent) => void; /** * A function that is executed each time the zoom factor is changed. */ onZoomFactorChanged?: ( e: DevExpress.viz.dxVectorMap.ZoomFactorChangedEvent ) => void; /** * Disables the panning capability. */ panningEnabled?: boolean; /** * Specifies the map projection. */ projection?: VectorMapProjection | VectorMapProjectionConfig | string | any; /** * Configures tooltips. */ tooltip?: DevExpress.viz.dxVectorMap.Tooltip; /** * Specifies whether the map should respond to touch gestures. */ touchEnabled?: boolean; /** * Specifies whether or not the map should respond when a user rolls the mouse wheel. */ wheelEnabled?: boolean; /** * Specifies a number that is used to zoom a map initially. */ zoomFactor?: number; /** * Disables the zooming capability. */ zoomingEnabled?: boolean; /** * Specifies settings common for all annotations in the VectorMap. */ commonAnnotationSettings?: dxVectorMapCommonAnnotationConfig; /** * Specifies the annotation collection. */ annotations?: Array; /** * Customizes an individual annotation. */ customizeAnnotation?: | (( annotation: dxVectorMapAnnotationConfig | any ) => dxVectorMapAnnotationConfig) | undefined; } /** * Allows you to export UI components using their SVG markup. */ export function exportFromMarkup( markup: string | DevExpress.core.UserDefinedElement, options: { fileName?: string; format?: string; backgroundColor?: string; width?: number; height?: number; onExporting?: Function; onExported?: Function; onFileSaving?: Function; margin?: number; svgToCanvas?: Function; } ): void; /** * Exports one or several UI components to PNG. */ export function exportWidgets( widgetInstances: VizWidget | Array | Array> ): void; /** * Exports one or several UI components. */ export function exportWidgets( widgetInstances: VizWidget | Array | Array>, options: { fileName?: string; format?: DevExpress.common.ExportFormat; backgroundColor?: string; margin?: number; gridLayout?: boolean; verticalAlignment?: DevExpress.common.VerticalAlignment; horizontalAlignment?: DevExpress.common.HorizontalAlignment; onExporting?: Function; onExported?: Function; onFileSaving?: Function; svgToCanvas?: Function; } ): void; /** * @deprecated Use Font from common/charts instead * @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 Font = DevExpress.common.charts.Font; /** * @deprecated Use LegendItem instead * @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 FunnelLegendItem extends DevExpress.common.charts.BaseLegendItem { /** * The funnel item that the legend item represents. */ item?: DevExpress.viz.dxFunnel.Item; } /** * A base object for gauge value and subvalue indicators. Includes the properties of indicators of all types. * @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 GaugeIndicator extends CommonIndicator { /** * Specifies the type of gauge indicators. */ type?: DevExpress.viz.BaseGauge.GaugeIndicatorType; } /** * Returns a subset of palette colors. */ export function generateColors( palette: DevExpress.common.charts.Palette | Array, count: number, options: { paletteExtensionMode?: DevExpress.common.charts.PaletteExtensionMode; baseColorSet?: DevExpress.common.charts.PaletteColorSet; } ): Array; /** * Gets the SVG markup of specific UI components for their subsequent export. */ export function getMarkup( widgetInstances: VizWidget | Array | Array> ): string; /** * Gets the color sets of a predefined or registered palette. */ export function getPalette(paletteName: string): any; /** * Gets a predefined or registered theme's settings. */ export function getTheme(theme: string): any; /** * This section describes the Layer object, which represents a vector map layer. * @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 MapLayer { /** * Deselects all layer elements. */ clearSelection(): void; /** * The type of the layer elements. */ elementType?: string; /** * Returns the DataSource instance. */ getDataSource(): DevExpress.common.data.DataSource; /** * Gets all layer elements. */ getElements(): Array; /** * The layer index in the layers array. */ index?: number; /** * The name of the layer. */ name?: string; /** * The layer type. Can be 'area', 'line' or 'marker'. */ type?: string; } /** * This section describes the Layer Element object, which represents a vector map layer element. * @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 MapLayerElement { /** * Applies the layer element settings and updates element appearance. */ applySettings(settings: any): void; /** * Gets the value of an attribute. */ attribute(name: string): any; /** * Sets the value of an attribute. */ attribute(name: string, value: any): void; /** * Gets the layer element coordinates. */ coordinates(): any; /** * The parent layer of the layer element. */ layer?: any; /** * Gets the selection state of the layer element. */ selected(): boolean; /** * Sets the selection state of the layer element. */ selected(state: boolean): void; } /** * @deprecated Use LegendItem instead * @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 PieChartLegendItem extends DevExpress.common.charts.BaseLegendItem { /** * The argument of the point(s) that the legend item represents. */ argument?: string | Date | number; /** * The zero-based index of the legend item used to identify the item among other legend items with the same argument. */ argumentIndex?: number; /** * An array of points that the legend item represents. Can contain more than one point only in a multi-series PieChart. */ points?: Array; /** * The text that the legend item displays. */ text?: any; } /** * Specifies properties for the series of the PieChart UI component. * @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 PieChartSeries extends dxPieChartSeriesTypesCommonPieChartSeries { /** * Specifies the name that identifies the series. */ name?: string | undefined; /** * Specifies data about a series. */ tag?: any | undefined; } /** * This section describes the Series object, which represents a series. * @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 pieChartSeriesObject extends baseSeriesObject { /** * Switches the series into the hover state, the same as when a user places the mouse pointer on it. */ hover(): void; /** * Switches the series from the hover state back to normal. */ clearHover(): void; /** * Provides information about the hover state of a series. */ isHovered(): boolean; } /** * This section describes the Point object, which represents a series point. * @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 piePointObject extends basePointObject { /** * Hides a specific point. */ hide(): void; /** * Provides information about the visibility state of a point. */ isVisible(): boolean; /** * Gets the percentage value of the specific point. */ percent?: string | number | Date; /** * Makes a specific point visible. */ show(): void; } /** * Specifies properties for PolarChart UI component series. * @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 PolarChartSeries extends dxPolarChartSeriesTypesCommonPolarChartSeries { /** * Specifies the name that identifies the series. */ name?: string | undefined; /** * Specifies data about a series. */ tag?: any | undefined; /** * Sets the series type. */ type?: DevExpress.viz.dxPolarChart.PolarChartSeriesType; } /** * This section describes the Series object, which represents a series. * @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 polarChartSeriesObject extends baseSeriesObject {} /** * This section describes the Point object, which represents a series point. * @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 polarPointObject extends basePointObject {} /** * The method to be called every time the active entry in the browser history is modified without reloading the current page. */ export function refreshPaths(): void; /** * Refreshes the current theme and palette in all data visualization UI components on the page. */ export function refreshTheme(): void; /** * Registers a new palette. */ export function registerPalette(paletteName: string, palette: any): void; /** * Registers a new theme based on the existing one. */ export function registerTheme(customTheme: any, baseTheme: string): void; /** * @deprecated Use LegendItem instead * @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 VectorMapLegendItem extends DevExpress.common.charts.BaseLegendItem { /** * The color of the legend item's marker. */ color?: string; /** * The end value of the group that the legend item indicates. */ end?: number; /** * The diameter of the legend item's marker in pixels. */ size?: number; /** * The start value of the group that the legend item indicates. */ start?: number; } export type VectorMapProjection = | 'equirectangular' | 'lambert' | 'mercator' | 'miller'; /** * * @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 VectorMapProjectionConfig { /** * Specifies the projection's ratio of the width to the height. */ aspectRatio?: number; /** * Converts coordinates from [x, y] to [lon, lat]. */ from?: (coordinates: Array) => Array; /** * Converts coordinates from [lon, lat] to [x, y]. */ to?: (coordinates: Array) => Array; } export type VizWidget = | dxChart | dxPieChart | dxFunnel | dxSankey | dxTreeMap | dxVectorMap | dxSparkline | dxBullet | dxBarGauge; } declare module DevExpress.viz.dxBarGauge { /** * An object that provides information about a legend item in the BarGauge UI component. */ export type LegendItem = BarGaugeLegendItem; } declare module DevExpress.viz.dxFunnel { export type Item = dxFunnelItem; /** * An object that provides information about a legend item in the Funnel UI component. */ export type LegendItem = FunnelLegendItem; } declare module DevExpress.viz.dxPieChart { /** * An object that provides information about a legend item in the PieChart UI component. */ export type LegendItem = PieChartLegendItem; } declare module DevExpress.viz.dxVectorMap { /** * An object that provides information about a legend item in the VectorMap UI component. */ export type LegendItem = VectorMapLegendItem; } declare module DevExpress.viz.map { /** * Creates a new projection. * @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 const projection: { /** * Adds a new projection to the internal projection storage. */ add(name: string, projectionConfig: VectorMapProjectionConfig | any): void; /** * Gets a predefined or custom projection from the projection storage. */ get(name: VectorMapProjection | string): any; (data: VectorMapProjectionConfig): any; }; } declare namespace DevExpress { /** @deprecated Use DevExpress.common.EventObject instead */ export type dxEvent = common.core.events.EventObject; /** @deprecated Use DevExpress.common.event instead */ export type event = events.event; } declare namespace DevExpress.viz { /** @deprecated Use DevExpress.viz.ChartSeries instead */ export type dxChartSeries = ChartSeries; /** @deprecated Use DevExpress.viz.PieChartSeries instead */ export type dxPieChartSeries = PieChartSeries; /** @deprecated Use DevExpress.viz.PolarChartSeries instead */ export type dxPolarChartSeries = PolarChartSeries; /** @deprecated Use DevExpress.viz instead */ export namespace charts { /** @deprecated */ export type dxChartOptions = viz.dxChartOptions; /** @deprecated */ export type dxChartArgumentAxis = viz.dxChartArgumentAxis; /** @deprecated */ export type dxChartArgumentAxisConstantLines = viz.dxChartArgumentAxisConstantLines; /** @deprecated */ export type dxChartArgumentAxisConstantLinesLabel = viz.dxChartArgumentAxisConstantLinesLabel; /** @deprecated */ export type dxChartArgumentAxisConstantLineStyle = viz.dxChartArgumentAxisConstantLineStyle; /** @deprecated */ export type dxChartArgumentAxisConstantLineStyleLabel = viz.dxChartArgumentAxisConstantLineStyleLabel; /** @deprecated */ export type dxChartArgumentAxisLabel = viz.dxChartArgumentAxisLabel; /** @deprecated */ export type dxChartArgumentAxisStrips = viz.dxChartArgumentAxisStrips; /** @deprecated */ export type dxChartArgumentAxisStripsLabel = viz.dxChartArgumentAxisStripsLabel; /** @deprecated */ export type dxChartArgumentAxisTitle = viz.dxChartArgumentAxisTitle; /** @deprecated */ export type dxChartCommonAxisSettings = viz.dxChartCommonAxisSettings; /** @deprecated */ export type dxChartCommonAxisSettingsConstantLineStyle = viz.dxChartCommonAxisSettingsConstantLineStyle; /** @deprecated */ export type dxChartCommonAxisSettingsConstantLineStyleLabel = viz.dxChartCommonAxisSettingsConstantLineStyleLabel; /** @deprecated */ export type dxChartCommonAxisSettingsLabel = viz.dxChartCommonAxisSettingsLabel; /** @deprecated */ export type dxChartCommonAxisSettingsStripStyle = viz.dxChartCommonAxisSettingsStripStyle; /** @deprecated */ export type dxChartCommonAxisSettingsStripStyleLabel = viz.dxChartCommonAxisSettingsStripStyleLabel; /** @deprecated */ export type dxChartCommonAxisSettingsTitle = viz.dxChartCommonAxisSettingsTitle; /** @deprecated */ export type dxChartCommonPaneSettings = viz.dxChartCommonPaneSettings; /** @deprecated */ export type dxChartCommonSeriesSettings = viz.dxChartCommonSeriesSettings; /** @deprecated */ export type dxChartLegend = viz.dxChartLegend; /** @deprecated */ export type dxChartPanes = viz.dxChartPanes; /** @deprecated */ export type dxChartSeries = viz.dxChartSeries; /** @deprecated */ export type dxChartTooltip = viz.dxChartTooltip; /** @deprecated */ export type dxChartValueAxis = viz.dxChartValueAxis; /** @deprecated */ export type dxChartValueAxisConstantLines = viz.dxChartValueAxisConstantLines; /** @deprecated */ export type dxChartValueAxisConstantLinesLabel = viz.dxChartValueAxisConstantLinesLabel; /** @deprecated */ export type dxChartValueAxisConstantLineStyle = viz.dxChartValueAxisConstantLineStyle; /** @deprecated */ export type dxChartValueAxisConstantLineStyleLabel = viz.dxChartValueAxisConstantLineStyleLabel; /** @deprecated */ export type dxChartValueAxisLabel = viz.dxChartValueAxisLabel; /** @deprecated */ export type dxChartValueAxisStrips = viz.dxChartValueAxisStrips; /** @deprecated */ export type dxChartValueAxisStripsLabel = viz.dxChartValueAxisStripsLabel; /** @deprecated */ export type dxChartValueAxisTitle = viz.dxChartValueAxisTitle; /** @deprecated */ export type dxPieChartOptions = viz.dxPieChartOptions; /** @deprecated */ export type dxPieChartAdaptiveLayout = viz.dxPieChartAdaptiveLayout; /** @deprecated */ export type dxPieChartLegend = viz.dxPieChartLegend; /** @deprecated */ export type dxPieChartSeries = viz.dxPieChartSeries; /** @deprecated */ export type dxPolarChartOptions = viz.dxPolarChartOptions; /** @deprecated */ export type dxPolarChartAdaptiveLayout = viz.dxPolarChartAdaptiveLayout; /** @deprecated */ export type dxPolarChartArgumentAxis = viz.dxPolarChartArgumentAxis; /** @deprecated */ export type dxPolarChartArgumentAxisConstantLines = viz.dxPolarChartArgumentAxisConstantLines; /** @deprecated */ export type dxPolarChartArgumentAxisConstantLinesLabel = viz.dxPolarChartArgumentAxisConstantLinesLabel; /** @deprecated */ export type dxPolarChartArgumentAxisLabel = viz.dxPolarChartArgumentAxisLabel; /** @deprecated */ export type dxPolarChartArgumentAxisStrips = viz.dxPolarChartArgumentAxisStrips; /** @deprecated */ export type dxPolarChartArgumentAxisStripsLabel = viz.dxPolarChartArgumentAxisStripsLabel; /** @deprecated */ export type dxPolarChartCommonAxisSettings = viz.dxPolarChartCommonAxisSettings; /** @deprecated */ export type dxPolarChartCommonAxisSettingsConstantLineStyle = viz.dxPolarChartCommonAxisSettingsConstantLineStyle; /** @deprecated */ export type dxPolarChartCommonAxisSettingsConstantLineStyleLabel = viz.dxPolarChartCommonAxisSettingsConstantLineStyleLabel; /** @deprecated */ export type dxPolarChartCommonAxisSettingsLabel = viz.dxPolarChartCommonAxisSettingsLabel; /** @deprecated */ export type dxPolarChartCommonAxisSettingsStripStyle = viz.dxPolarChartCommonAxisSettingsStripStyle; /** @deprecated */ export type dxPolarChartCommonAxisSettingsStripStyleLabel = viz.dxPolarChartCommonAxisSettingsStripStyleLabel; /** @deprecated */ export type dxPolarChartCommonAxisSettingsTick = viz.dxPolarChartCommonAxisSettingsTick; /** @deprecated */ export type dxPolarChartCommonSeriesSettings = viz.dxPolarChartCommonSeriesSettings; /** @deprecated */ export type dxPolarChartLegend = viz.dxPolarChartLegend; /** @deprecated */ export type dxPolarChartSeries = viz.dxPolarChartSeries; /** @deprecated */ export type dxPolarChartTooltip = viz.dxPolarChartTooltip; /** @deprecated */ export type dxPolarChartValueAxis = viz.dxPolarChartValueAxis; /** @deprecated */ export type dxPolarChartValueAxisConstantLines = viz.dxPolarChartValueAxisConstantLines; /** @deprecated */ export type dxPolarChartValueAxisConstantLinesLabel = viz.dxPolarChartValueAxisConstantLinesLabel; /** @deprecated */ export type dxPolarChartValueAxisLabel = viz.dxPolarChartValueAxisLabel; /** @deprecated */ export type dxPolarChartValueAxisStrips = viz.dxPolarChartValueAxisStrips; /** @deprecated */ export type dxPolarChartValueAxisStripsLabel = viz.dxPolarChartValueAxisStripsLabel; /** @deprecated */ export type dxPolarChartValueAxisTick = viz.dxPolarChartValueAxisTick; } /** @deprecated Use DevExpress.viz instead */ export namespace funnel { /** @deprecated */ export type dxFunnelOptions = viz.dxFunnelOptions; /** @deprecated */ export type dxFunnelTooltip = viz.dxFunnelTooltip; } /** @deprecated Use DevExpress.viz instead */ export namespace gauges { /** @deprecated */ export type dxCircularGaugeOptions = viz.dxCircularGaugeOptions; /** @deprecated */ export type dxCircularGaugeRangeContainer = viz.dxCircularGaugeRangeContainer; /** @deprecated */ export type dxCircularGaugeScale = viz.dxCircularGaugeScale; /** @deprecated */ export type dxCircularGaugeScaleLabel = viz.dxCircularGaugeScaleLabel; /** @deprecated */ export type dxLinearGaugeOptions = viz.dxLinearGaugeOptions; /** @deprecated */ export type dxLinearGaugeRangeContainer = viz.dxLinearGaugeRangeContainer; /** @deprecated */ export type dxLinearGaugeScale = viz.dxLinearGaugeScale; /** @deprecated */ export type dxLinearGaugeScaleLabel = viz.dxLinearGaugeScaleLabel; /** @deprecated */ export type dxBarGaugeOptions = viz.dxBarGaugeOptions; /** @deprecated */ export type dxBarGaugeTooltip = viz.dxBarGaugeTooltip; } /** @deprecated Use DevExpress.viz instead */ export namespace rangeSelector { /** @deprecated */ export type dxRangeSelectorOptions = viz.dxRangeSelectorOptions; } /** @deprecated Use DevExpress.viz instead */ export namespace sparklines { /** @deprecated */ export type dxSparklineOptions = viz.dxSparklineOptions; /** @deprecated */ export type dxBulletOptions = viz.dxBulletOptions; } /** @deprecated Use DevExpress.viz instead */ export namespace map { /** @deprecated */ export type dxVectorMapOptions = viz.dxVectorMapOptions; /** @deprecated */ export type dxVectorMapTooltip = viz.dxVectorMapTooltip; } /** @deprecated Use DevExpress.viz instead */ export namespace treeMap { /** @deprecated */ export type dxTreeMapOptions = viz.dxTreeMapOptions; /** @deprecated */ export type dxTreeMapTooltip = viz.dxTreeMapTooltip; } } declare namespace DevExpress.ui { /** @deprecated Use DevExpress.ui.dxAccordionItem */ export type dxAccordionItemTemplate = dxAccordionItem; /** @deprecated Use DevExpress.ui.dxActionSheetItem */ export type dxActionSheetItemTemplate = dxActionSheetItem; /** @deprecated Use DevExpress.ui.dxBoxItem */ export type dxBoxItemTemplate = dxBoxItem; /** @deprecated Use DevExpress.ui.dxGalleryItem */ export type dxGalleryItemTemplate = dxGalleryItem; /** @deprecated Use DevExpress.ui.dxMultiViewItem */ export type dxMultiViewItemTemplate = dxMultiViewItem; /** @deprecated Use DevExpress.ui.dxResponsiveBoxItem */ export type dxResponsiveBoxItemTemplate = dxResponsiveBoxItem; /** @deprecated Use DevExpress.ui.dxSchedulerAppointment */ export type dxSchedulerAppointmentTemplate = dxSchedulerAppointment; /** @deprecated Use DevExpress.ui.dxTabsItem */ export type dxTabsItemTemplate = dxTabsItem; /** @deprecated Use DevExpress.ui.dxTabPanelItem */ export type dxTabPanelItemTemplate = dxTabPanelItem; /** @deprecated Use DevExpress.ui.dxTileViewItem */ export type dxTileViewItemTemplate = dxTileViewItem; /** @deprecated Use DevExpress.ui.dxToolbarItem */ export type dxToolbarItemTemplate = dxToolbarItem; /** @deprecated Use DevExpress.ui.CollectionWidgetItem */ export type CollectionWidgetItemTemplate = CollectionWidgetItem; /** @deprecated Use DevExpress.ui.dxContextMenuItem */ export type dxContextMenuItemTemplate = dxContextMenuItem; /** @deprecated Use DevExpress.ui.dxMenuBaseItem */ export type dxMenuBaseItemTemplate = dxMenuBaseItem; /** @deprecated Use DevExpress.ui.CollectionWidgetItem */ export type DataExpressionMixinItemTemplate = CollectionWidgetItem; /** @deprecated Use DevExpress.ui.dxListItem */ export type dxListItemTemplate = dxListItem; /** @deprecated Use DevExpress.ui.dxMenuItem */ export type dxMenuItemTemplate = dxMenuItem; /** @deprecated Use DevExpress.ui.dxTreeViewItem */ export type dxTreeViewItemTemplate = dxTreeViewItem; } // v22.1 declare namespace DevExpress.ui { /** @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 GridBase = common.grids.GridBase; /** @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 GridBaseOptions, TRowData = any, TKey = any> = common.grids.GridBaseOptions; } declare namespace DevExpress.ui.dxDataGrid { /** @deprecated Use DevExpress.common.Scrollable */ export type Scrollable = common.Scrollable; /** @deprecated Use DevExpress.common.grids.ColumnChooser instead */ export type ColumnChooser = common.grids.ColumnChooser; /** @deprecated Use DevExpress.common.grids.ColumnCustomizeTextArg instead */ export type ColumnCustomizeTextArg = common.grids.ColumnCustomizeTextArg; /** @deprecated Use DevExpress.common.grids.ColumnFixing instead */ export type ColumnFixing = common.grids.ColumnFixing; /** @deprecated Use DevExpress.common.grids.ColumnFixingTexts instead */ export type ColumnFixingTexts = common.grids.ColumnFixingTexts; /** @deprecated Use DevExpress.common.grids.ColumnHeaderFilter instead */ export type ColumnHeaderFilter = common.grids.ColumnHeaderFilter; /** @deprecated Use DevExpress.common.grids.ColumnLookup instead */ export type ColumnLookup = common.grids.ColumnLookup; /** @deprecated Use DevExpress.common.grids.DataChange instead */ export type DataChange = common.grids.DataChange; /** @deprecated Use DevExpress.common.grids.FilterPanelTexts instead */ export type FilterPanelTexts = common.grids.FilterPanelTexts; /** @deprecated Use DevExpress.common.grids.FilterRow instead */ export type FilterRow = common.grids.FilterRow; /** @deprecated Use DevExpress.common.grids.FilterRowOperationDescriptions instead */ export type FilterRowOperationDescriptions = common.grids.FilterRowOperationDescriptions; /** @deprecated Use DevExpress.common.grids.HeaderFilter instead */ export type HeaderFilter = common.grids.HeaderFilter; /** @deprecated Use DevExpress.common.grids.HeaderFilterGroupInterval instead */ export type HeaderFilterGroupInterval = common.grids.HeaderFilterGroupInterval; /** @deprecated Use DevExpress.common.grids.HeaderFilterTexts instead */ export type HeaderFilterTexts = common.grids.HeaderFilterTexts; /** @deprecated Use DevExpress.common.grids.KeyboardNavigation instead */ export type KeyboardNavigation = common.grids.KeyboardNavigation; /** @deprecated Use DevExpress.common.grids.LoadPanel instead */ export type LoadPanel = common.grids.LoadPanel; /** @deprecated Use DevExpress.common.grids.Pager instead */ export type Pager = common.grids.Pager; /** @deprecated Use DevExpress.common.grids.RowDraggingTemplateData instead */ export type RowDraggingTemplateData = common.grids.RowDraggingTemplateData; /** @deprecated Use DevExpress.common.grids.RowDraggingTemplateData instead */ export type RowDraggingTemplateDataModel = common.grids.RowDraggingTemplateData; /** @deprecated Use DevExpress.common.grids.SearchPanel instead */ export type SearchPanel = common.grids.SearchPanel; /** @deprecated Use DevExpress.common.grids.Sorting instead */ export type Sorting = common.grids.Sorting; /** @deprecated Use DevExpress.common.grids.StateStoring instead */ export type StateStoring = common.grids.StateStoring; /** @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 AdaptiveDetailRowPreparingInfo = common.grids.AdaptiveDetailRowPreparingInfo; /** @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 DataChangeInfo = common.grids.DataChangeInfo; /** @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 DataErrorOccurredInfo = common.grids.DataErrorOccurredInfo; /** @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 DragDropInfo = common.grids.DragDropInfo; /** @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 DragReorderInfo = common.grids.DragReorderInfo; /** @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 DragStartEventInfo = common.grids.DragStartEventInfo; /** @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 KeyDownInfo = common.grids.KeyDownInfo; /** @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 NewRowInfo = common.grids.NewRowInfo; /** @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 PagingBase = common.grids.PagingBase; /** @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 RowDraggingEventInfo = common.grids.RowDraggingEventInfo; /** @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 RowInsertedInfo = common.grids.RowInsertedInfo; /** @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 RowInsertingInfo = common.grids.RowInsertingInfo; /** @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 RowKeyInfo = common.grids.RowKeyInfo; /** @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 RowRemovedInfo = common.grids.RowRemovedInfo; /** @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 RowRemovingInfo = common.grids.RowRemovingInfo; /** @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 RowUpdatedInfo = common.grids.RowUpdatedInfo; /** @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 RowUpdatingInfo = common.grids.RowUpdatingInfo; /** @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 RowValidatingInfo = common.grids.RowValidatingInfo; /** @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 SavingInfo = common.grids.SavingInfo; /** @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 SelectionChangedInfo = common.grids.SelectionChangedInfo; /** @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 ToolbarPreparingInfo = common.grids.ToolbarPreparingInfo; } declare namespace DevExpress.common.charts { /** @deprecated Use DevExpress.common.grids.ApplyChangesMode instead */ export type ApplyChangesMode = grids.ApplyChangesMode; /** @deprecated Use DevExpress.common.grids.ApplyFilterMode instead */ export type ApplyFilterMode = grids.ApplyFilterMode; /** @deprecated Use DevExpress.common.grids.ColumnChooserMode instead */ export type ColumnChooserMode = grids.ColumnChooserMode; /** @deprecated Use DevExpress.common.grids.ColumnResizeMode instead */ export type ColumnResizeMode = grids.ColumnResizeMode; /** @deprecated Use DevExpress.common.grids.DataChangeType instead */ export type DataChangeType = grids.DataChangeType; /** @deprecated Use DevExpress.common.grids.DataRenderMode instead */ export type DataRenderMode = grids.DataRenderMode; /** @deprecated Use DevExpress.common.grids.EnterKeyAction instead */ export type EnterKeyAction = grids.EnterKeyAction; /** @deprecated Use DevExpress.common.grids.EnterKeyDirection instead */ export type EnterKeyDirection = grids.EnterKeyDirection; /** @deprecated Use DevExpress.common.grids.FilterOperation instead */ export type FilterOperation = grids.FilterOperation; /** @deprecated Use DevExpress.common.grids.FilterType instead */ export type FilterType = grids.FilterType; /** @deprecated Use DevExpress.common.grids.GridsEditMode instead */ export type GridsEditMode = grids.GridsEditMode; /** @deprecated Use DevExpress.common.grids.GridsEditRefreshMode instead */ export type GridsEditRefreshMode = grids.GridsEditRefreshMode; /** @deprecated Use DevExpress.common.grids.GroupExpandMode instead */ export type GroupExpandMode = grids.GroupExpandMode; /** @deprecated Use DevExpress.common.grids.NewRowPosition instead */ export type NewRowPosition = grids.NewRowPosition; /** @deprecated Use DevExpress.common.DisplayMode instead */ export type PagerDisplayMode = DisplayMode; /** @deprecated Use DevExpress.common.grids.PagerPageSize instead */ export type PagerPageSize = grids.PagerPageSize; /** @deprecated Use DevExpress.common.grids.SelectedFilterOperation instead */ export type SelectedFilterOperation = grids.SelectedFilterOperation; /** @deprecated Use DevExpress.common.grids.SelectionColumnDisplayMode instead */ export type SelectionColumnDisplayMode = grids.SelectionColumnDisplayMode; /** @deprecated Use DevExpress.common.grids.StartEditAction instead */ export type StartEditAction = grids.StartEditAction; /** @deprecated Use DevExpress.common.grids.StateStoreType instead */ export type StateStoreType = grids.StateStoreType; /** @deprecated Use DevExpress.common.grids.SummaryType instead */ export type SummaryType = grids.SummaryType; } // v22.2 declare namespace DevExpress { /** @deprecated Use DevExpress.GlobalConfig instead */ export type globalConfig = common.GlobalConfig; } declare namespace DevExpress.ui { /** @deprecated Use DevExpress.common.AsyncRule instead */ export type AsyncRule = common.AsyncRule; /** @deprecated Use DevExpress.common.CompareRule instead */ export type CompareRule = common.CompareRule; /** @deprecated Use DevExpress.common.CustomRule instead */ export type CustomRule = common.CustomRule; /** @deprecated Use DevExpress.common.EmailRule instead */ export type EmailRule = common.EmailRule; /** @deprecated Use DevExpress.common.NumericRule instead */ export type NumericRule = common.NumericRule; /** @deprecated Use DevExpress.common.PatternRule instead */ export type PatternRule = common.PatternRule; /** @deprecated Use DevExpress.common.RangeRule instead */ export type RangeRule = common.RangeRule; /** @deprecated Use DevExpress.common.RequiredRule instead */ export type RequiredRule = common.RequiredRule; /** @deprecated Use DevExpress.common.StringLengthRule instead */ export type StringLengthRule = common.StringLengthRule; /** @deprecated Use DevExpress.common.ValidationCallbackData instead */ export type ValidationCallbackData = common.ValidationCallbackData; /** @deprecated Use DevExpress.common.ValidationRule instead */ export type ValidationRule = common.ValidationRule; /** @deprecated Use DevExpress.common.ValidationRuleType instead */ export type ValidationRuleType = common.ValidationRuleType; } declare namespace DevExpress.viz { /** @deprecated Use DevExpress.common.charts.ScaleBreak instead */ export type ScaleBreak = common.charts.ScaleBreak; /** @deprecated Use DevExpress.common.charts.SeriesType instead */ export type SeriesType = common.charts.SeriesType; /** @deprecated Use DevExpress.common.charts.VisualRange instead */ export type VisualRange = common.charts.VisualRange; /** @deprecated Use DevExpress.common.charts.TimeIntervalConfig instead */ export type VizTimeInterval = common.charts.TimeIntervalConfig; /** @deprecated Use DevExpress.common.charts.SeriesPoint instead */ export type dxChartSeriesTypesCommonSeriesPoint = common.charts.SeriesPoint; /** @deprecated Use DevExpress.common.charts.SeriesLabel instead */ export type dxChartSeriesTypesCommonSeriesLabel = common.charts.SeriesLabel; /** @deprecated Use DevExpress.common.charts.LegendItem instead */ export type BaseChartLegendItem = common.charts.LegendItem; } declare namespace DevExpress.data { /** @deprecated Use DevExpress.common.data.StoreOptions instead */ export type StoreOptions = common.data.StoreOptions; } // v23.1 declare namespace DevExpress.ui.dxSlider { /** @deprecated Use DevExpress.common.SliderValueChangeMode instead */ export type ValueChangeMode = common.SliderValueChangeMode; } declare namespace DevExpress.viz.dxFunnel { /** @deprecated Use DevExpress.common.charts.ShiftLabelOverlap instead */ export type FunnelLabelOverlap = common.charts.ShiftLabelOverlap; } declare namespace DevExpress.viz.dxPieChart { /** @deprecated Use DevExpress.common.charts.ShiftLabelOverlap instead */ export type PieChartLabelOverlap = common.charts.ShiftLabelOverlap; } declare namespace DevExpress.viz { /** @deprecated Use DevExpress.viz.dxBarGauge.Legend instead */ export type dxBarGaugeLegend = dxBarGauge.Legend; /** @deprecated Use DevExpress.viz.dxBarGauge.LoadingIndicator instead */ export type dxBarGaugeLoadingIndicator = dxBarGauge.LoadingIndicator; /** @deprecated Use DevExpress.viz.dxBarGauge.Tooltip instead */ export type dxBarGaugeTooltip = dxBarGauge.Tooltip; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxis instead */ export type dxChartArgumentAxis = dxChart.ArgumentAxis; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisConstantLines instead */ export type dxChartArgumentAxisConstantLines = dxChart.ArgumentAxisConstantLines; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisConstantLinesLabel instead */ export type dxChartArgumentAxisConstantLinesLabel = dxChart.ArgumentAxisConstantLinesLabel; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisConstantLineStyle instead */ export type dxChartArgumentAxisConstantLineStyle = dxChart.ArgumentAxisConstantLineStyle; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisConstantLineStyleLabel instead */ export type dxChartArgumentAxisConstantLineStyleLabel = dxChart.ArgumentAxisConstantLineStyleLabel; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisLabel instead */ export type dxChartArgumentAxisLabel = dxChart.ArgumentAxisLabel; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisStrips instead */ export type dxChartArgumentAxisStrips = dxChart.ArgumentAxisStrips; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisStripsLabel instead */ export type dxChartArgumentAxisStripsLabel = dxChart.ArgumentAxisStripsLabel; /** @deprecated Use DevExpress.viz.dxChart.ArgumentAxisTitle instead */ export type dxChartArgumentAxisTitle = dxChart.ArgumentAxisTitle; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettings instead */ export type dxChartCommonAxisSettings = dxChart.CommonAxisSettings; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsConstantLineStyle instead */ export type dxChartCommonAxisSettingsConstantLineStyle = dxChart.CommonAxisSettingsConstantLineStyle; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsConstantLineStyleLabel instead */ export type dxChartCommonAxisSettingsConstantLineStyleLabel = dxChart.CommonAxisSettingsConstantLineStyleLabel; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsLabel instead */ export type dxChartCommonAxisSettingsLabel = dxChart.CommonAxisSettingsLabel; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsStripStyle instead */ export type dxChartCommonAxisSettingsStripStyle = dxChart.CommonAxisSettingsStripStyle; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsStripStyleLabel instead */ export type dxChartCommonAxisSettingsStripStyleLabel = dxChart.CommonAxisSettingsStripStyleLabel; /** @deprecated Use DevExpress.viz.dxChart.CommonAxisSettingsTitle instead */ export type dxChartCommonAxisSettingsTitle = dxChart.CommonAxisSettingsTitle; /** @deprecated Use DevExpress.viz.dxChart.CommonPaneSettings instead */ export type dxChartCommonPaneSettings = dxChart.CommonPaneSettings; /** @deprecated Use DevExpress.viz.dxChart.CommonSeriesSettings instead */ export type dxChartCommonSeriesSettings = dxChart.CommonSeriesSettings; /** @deprecated Use DevExpress.viz.dxChart.Legend instead */ export type dxChartLegend = dxChart.Legend; /** @deprecated Use DevExpress.viz.dxChart.Panes instead */ export type dxChartPanes = dxChart.Panes; /** @deprecated Use DevExpress.viz.dxChart.Tooltip instead */ export type dxChartTooltip = dxChart.Tooltip; /** @deprecated Use DevExpress.viz.dxChart.ValueAxis instead */ export type dxChartValueAxis = dxChart.ValueAxis; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisConstantLines instead */ export type dxChartValueAxisConstantLines = dxChart.ValueAxisConstantLines; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisConstantLinesLabel instead */ export type dxChartValueAxisConstantLinesLabel = dxChart.ValueAxisConstantLinesLabel; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisConstantLineStyle instead */ export type dxChartValueAxisConstantLineStyle = dxChart.ValueAxisConstantLineStyle; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisConstantLineStyleLabel instead */ export type dxChartValueAxisConstantLineStyleLabel = dxChart.ValueAxisConstantLineStyleLabel; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisLabel instead */ export type dxChartValueAxisLabel = dxChart.ValueAxisLabel; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisStrips instead */ export type dxChartValueAxisStrips = dxChart.ValueAxisStrips; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisStripsLabel instead */ export type dxChartValueAxisStripsLabel = dxChart.ValueAxisStripsLabel; /** @deprecated Use DevExpress.viz.dxChart.ValueAxisTitle instead */ export type dxChartValueAxisTitle = dxChart.ValueAxisTitle; /** @deprecated Use DevExpress.viz.dxPolarChart.AdaptiveLayout instead */ export type dxPolarChartAdaptiveLayout = dxPolarChart.AdaptiveLayout; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxis instead */ export type dxPolarChartArgumentAxis = dxPolarChart.ArgumentAxis; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisConstantLines instead */ export type dxPolarChartArgumentAxisConstantLines = dxPolarChart.ArgumentAxisConstantLines; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisConstantLinesLabel instead */ export type dxPolarChartArgumentAxisConstantLinesLabel = dxPolarChart.ArgumentAxisConstantLinesLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisLabel instead */ export type dxPolarChartArgumentAxisLabel = dxPolarChart.ArgumentAxisLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisMinorTick instead */ export type dxPolarChartArgumentAxisMinorTick = dxPolarChart.ArgumentAxisMinorTick; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisStrips instead */ export type dxPolarChartArgumentAxisStrips = dxPolarChart.ArgumentAxisStrips; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisStripsLabel instead */ export type dxPolarChartArgumentAxisStripsLabel = dxPolarChart.ArgumentAxisStripsLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ArgumentAxisTick instead */ export type dxPolarChartArgumentAxisTick = dxPolarChart.ArgumentAxisTick; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettings instead */ export type dxPolarChartCommonAxisSettings = dxPolarChart.CommonAxisSettings; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsConstantLineStyle instead */ export type dxPolarChartCommonAxisSettingsConstantLineStyle = dxPolarChart.CommonAxisSettingsConstantLineStyle; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsConstantLineStyleLabel instead */ export type dxPolarChartCommonAxisSettingsConstantLineStyleLabel = dxPolarChart.CommonAxisSettingsConstantLineStyleLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsLabel instead */ export type dxPolarChartCommonAxisSettingsLabel = dxPolarChart.CommonAxisSettingsLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsMinorTick instead */ export type dxPolarChartCommonAxisSettingsMinorTick = dxPolarChart.CommonAxisSettingsMinorTick; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsStripStyle instead */ export type dxPolarChartCommonAxisSettingsStripStyle = dxPolarChart.CommonAxisSettingsStripStyle; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsStripStyleLabel instead */ export type dxPolarChartCommonAxisSettingsStripStyleLabel = dxPolarChart.CommonAxisSettingsStripStyleLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonAxisSettingsTick instead */ export type dxPolarChartCommonAxisSettingsTick = dxPolarChart.CommonAxisSettingsTick; /** @deprecated Use DevExpress.viz.dxPolarChart.CommonSeriesSettings instead */ export type dxPolarChartCommonSeriesSettings = dxPolarChart.CommonSeriesSettings; /** @deprecated Use DevExpress.viz.dxPolarChart.Legend instead */ export type dxPolarChartLegend = dxPolarChart.Legend; /** @deprecated Use DevExpress.viz.dxPolarChart.Tooltip instead */ export type dxPolarChartTooltip = dxPolarChart.Tooltip; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxis instead */ export type dxPolarChartValueAxis = dxPolarChart.ValueAxis; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisConstantLines instead */ export type dxPolarChartValueAxisConstantLines = dxPolarChart.ValueAxisConstantLines; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisConstantLinesLabel instead */ export type dxPolarChartValueAxisConstantLinesLabel = dxPolarChart.ValueAxisConstantLinesLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisLabel instead */ export type dxPolarChartValueAxisLabel = dxPolarChart.ValueAxisLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisStrips instead */ export type dxPolarChartValueAxisStrips = dxPolarChart.ValueAxisStrips; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisStripsLabel instead */ export type dxPolarChartValueAxisStripsLabel = dxPolarChart.ValueAxisStripsLabel; /** @deprecated Use DevExpress.viz.dxPolarChart.ValueAxisTick instead */ export type dxPolarChartValueAxisTick = dxPolarChart.ValueAxisTick; /** @deprecated Use DevExpress.viz.dxCircularGauge.RangeContainer instead */ export type dxCircularGaugeRangeContainer = dxCircularGauge.RangeContainer; /** @deprecated Use DevExpress.viz.dxCircularGauge.Scale instead */ export type dxCircularGaugeScale = dxCircularGauge.Scale; /** @deprecated Use DevExpress.viz.dxCircularGauge.ScaleLabel instead */ export type dxCircularGaugeScaleLabel = dxCircularGauge.ScaleLabel; /** @deprecated Use DevExpress.viz.dxFunnel.Legend instead */ export type dxFunnelLegend = dxFunnel.Legend; /** @deprecated Use DevExpress.viz.dxFunnel.Tooltip instead */ export type dxFunnelTooltip = dxFunnel.Tooltip; /** @deprecated Use DevExpress.viz.dxLinearGauge.RangeContainer instead */ export type dxLinearGaugeRangeContainer = dxLinearGauge.RangeContainer; /** @deprecated Use DevExpress.viz.dxLinearGauge.Scale instead */ export type dxLinearGaugeScale = dxLinearGauge.Scale; /** @deprecated Use DevExpress.viz.dxLinearGauge.ScaleLabel instead */ export type dxLinearGaugeScaleLabel = dxLinearGauge.ScaleLabel; /** @deprecated Use DevExpress.viz.dxPieChart.AdaptiveLayout instead */ export type dxPieChartAdaptiveLayout = dxPieChart.AdaptiveLayout; /** @deprecated Use DevExpress.viz.dxPieChart.Legend instead */ export type dxPieChartLegend = dxPieChart.Legend; /** @deprecated Use DevExpress.viz.dxSankey.Tooltip instead */ export type dxSankeyTooltip = dxSankey.Tooltip; /** @deprecated Use DevExpress.viz.dxTreeMap.Tooltip instead */ export type dxTreeMapTooltip = dxTreeMap.Tooltip; /** @deprecated Use DevExpress.viz.dxVectorMap.Legend instead */ export type dxVectorMapLegends = dxVectorMap.Legend; /** @deprecated Use DevExpress.viz.dxVectorMap.Tooltip instead */ export type dxVectorMapTooltip = dxVectorMap.Tooltip; } declare namespace DevExpress.ui { /** @deprecated Use DevExpress.ui.dxDataGrid.Editing instead */ export type dxDataGridEditing = dxDataGrid.Editing; /** @deprecated Use DevExpress.ui.dxDataGrid.Scrolling instead */ export type dxDataGridScrolling = dxDataGrid.Scrolling; /** @deprecated Use DevExpress.ui.dxDataGrid.Selection instead */ export type dxDataGridSelection = dxDataGrid.Selection; /** @deprecated Use DevExpress.ui.dxTreeList.Editing instead */ export type dxTreeListEditing = dxTreeList.Editing; /** @deprecated Use DevExpress.ui.dxTreeList.Scrolling instead */ export type dxTreeListScrolling = dxTreeList.Scrolling; /** @deprecated Use DevExpress.ui.dxTreeList.Selection instead */ export type dxTreeListSelection = dxTreeList.Selection; /** @deprecated Use DevExpress.ui.dxTreeList.EditingTexts instead */ export type dxTreeListEditingTexts = dxTreeList.EditingTexts; /** @deprecated Use DevExpress.ui.dxTreeList.Paging instead */ export type dxTreeListPaging = dxTreeList.Paging; /** @deprecated Use DevExpress.ui.dxDataGrid.Column instead */ export type GridBaseColumn = dxDataGrid.ColumnBase; /** @deprecated Use DevExpress.ui.dxDataGrid.ColumnButton instead */ export type GridBaseColumnButton = dxDataGrid.ColumnButtonBase; /** @deprecated Use DevExpress.ui.dxDataGrid.Editing instead */ export type GridBaseEditing = dxDataGrid.EditingBase; /** @deprecated Use DevExpress.ui.dxDataGrid.EditingTexts instead */ export type GridBaseEditingTexts = dxDataGrid.EditingTextsBase; /** @deprecated Use DevExpress.ui.dxDataGrid.Paging instead */ export type GridBasePaging = dxDataGrid.Paging; /** @deprecated Use DevExpress.ui.dxDataGrid.Scrolling instead */ export type GridBaseScrolling = dxDataGrid.Scrolling; /** @deprecated Use DevExpress.ui.dxDataGrid.Selection instead */ export type GridBaseSelection = dxDataGrid.Selection; } declare namespace DevExpress.ui.dxDataGrid { /** @deprecated Use DevExpress.ui.dxDataGrid.SortByGroupSummaryInfoItem instead */ export type dxDataGridSortByGroupSummaryInfoItem = SortByGroupSummaryInfoItem; /** @deprecated Use DevExpress.ui.dxDataGrid.EditingTexts instead */ export type EditingTextsBase = EditingTexts; } // v24.1 declare namespace DevExpress.ui { /** @deprecated DevExpress.ui.dxDiagram.CustomCommand instead */ export type dxDiagramCustomCommand = dxDiagram.CustomCommand; } declare namespace DevExpress.ui.dxDiagram { /** @deprecated Use DevExpress.ui.dxDiagram.AutoZoomMode instead */ export type DiagramAutoZoomMode = AutoZoomMode; /** @deprecated Use DevExpress.ui.dxDiagram.Command instead */ export type DiagramCommand = Command; /** @deprecated Use DevExpress.ui.dxDiagram.ConnectorLineEnd instead */ export type DiagramConnectorLineEnd = ConnectorLineEnd; /** @deprecated Use DevExpress.ui.dxDiagram.ConnectorLineType instead */ export type DiagramConnectorLineType = ConnectorLineType; /** @deprecated Use DevExpress.ui.dxDiagram.ConnectorPosition instead */ export type DiagramConnectorPosition = ConnectorPosition; /** @deprecated Use DevExpress.ui.dxDiagram.DataLayoutType instead */ export type DiagramDataLayoutType = DataLayoutType; /** @deprecated Use DevExpress.ui.dxDiagram.ItemType instead */ export type DiagramItemType = ItemType; /** @deprecated Use DevExpress.ui.dxDiagram.ModelOperation instead */ export type DiagramModelOperation = ModelOperation; /** @deprecated Use DevExpress.ui.dxDiagram.PanelVisibility instead */ export type DiagramPanelVisibility = PanelVisibility; /** @deprecated Use DevExpress.ui.dxDiagram.RequestEditOperationReason instead */ export type DiagramRequestEditOperationReason = RequestEditOperationReason; /** @deprecated Use DevExpress.ui.dxDiagram.ShapeCategory instead */ export type DiagramShapeCategory = ShapeCategory; /** @deprecated Use DevExpress.ui.dxDiagram.ShapeType instead */ export type DiagramShapeType = ShapeType; /** @deprecated Use DevExpress.ui.dxDiagram.ToolboxDisplayMode instead */ export type DiagramToolboxDisplayMode = ToolboxDisplayMode; /** @deprecated Use DevExpress.ui.dxDiagram.Units instead */ export type DiagramUnits = Units; } // 24.2 declare namespace DevExpress.common.grids { /** @deprecated Use DevExpress.common.DisplayMode instead */ export type PagerDisplayMode = DisplayMode; } declare namespace DevExpress { export type AnimationConfig = common.core.animation.AnimationConfig; export const animationPresets: typeof common.core.animation.animationPresets; export type Device = common.core.environment.Device; export const devices: typeof common.core.environment.devices; export type dxSchedulerTimeZone = common.core.environment.SchedulerTimeZone; export class EndpointSelector extends common.data.EndpointSelector {} export const fx: typeof common.core.animation.fx; export const hideTopOverlay: typeof common.core.environment.hideTopOverlay; export type PositionConfig = common.core.animation.PositionConfig; export class TransitionExecutor extends common.core.animation.TransitionExecutor {} } declare namespace DevExpress.localization { export const formatDate: typeof common.core.localization.formatDate; export const formatMessage: typeof common.core.localization.formatMessage; export const formatNumber: typeof common.core.localization.formatNumber; export const loadMessages: typeof common.core.localization.loadMessages; export const locale: typeof common.core.localization.locale; export const parseDate: typeof common.core.localization.parseDate; export const parseNumber: typeof common.core.localization.parseNumber; } declare namespace DevExpress.common { export type GroupItem = data.GroupItem; export const isGroupItemsArray: typeof common.data.isGroupItemsArray; export const isItemsArray: typeof common.data.isItemsArray; export const isLoadResultObject: typeof common.data.isLoadResultObject; export type LoadResult = data.LoadResult; export type LoadResultObject = data.LoadResultObject; } declare namespace DevExpress.animation { export type AnimationState = common.core.animation.AnimationState; export type CollisionResolution = common.core.animation.CollisionResolution; export type CollisionResolutionCombination = common.core.animation.CollisionResolutionCombination; } declare namespace DevExpress.data { export const applyChanges: typeof common.data.applyChanges; export class ArrayStore extends common.data.ArrayStore {} export const base64_encode: typeof common.data.base64_encode; export class CustomStore extends common.data.CustomStore {} export class DataSource extends common.data.DataSource {} export class EdmLiteral extends common.data.EdmLiteral {} export const errorHandler: typeof common.data.errorHandler; export type LangParams = common.data.LangParams; export class LocalStore extends common.data.LocalStore {} export class ODataContext extends common.data.ODataContext {} export class ODataStore extends common.data.ODataStore {} export const query: typeof common.data.query; export type Query = common.data.Query; export const setErrorHandler: typeof common.data.setErrorHandler; export class Store extends common.data.Store{} } declare namespace DevExpress.data.CustomStore { export type GroupItem = common.data.GroupItem; export type ResolvedData = common.data.ResolvedData; } declare namespace DevExpress.data.DataSource { export type Options = common.data.DataSourceOptions; } declare namespace DevExpress.data.Store { export type Options = common.data.StoreOptions; } declare namespace DevExpress.data.utils { export const compileGetter: typeof common.data.compileGetter; export const compileSetter: typeof common.data.compileSetter; } declare namespace DevExpress.data.utils.odata { export const keyConverters: typeof common.data.keyConverters; } declare namespace DevExpress.events { export type AsyncCancelable = common.core.events.AsyncCancelable; export type Cancelable = common.core.events.Cancelable; export type ChangedOptionInfo = common.core.events.ChangedOptionInfo; export type EventInfo = common.core.events.EventInfo; export type InitializedEventInfo = common.core.events.InitializedEventInfo; export type ItemInfo = common.core.events.ItemInfo; export type NativeEventInfo = common.core.events.NativeEventInfo; export const off: typeof common.core.events.off; export const on: typeof common.core.events.on; export const one: typeof common.core.events.one; export const trigger: typeof common.core.events.trigger; } declare namespace DevExpress.excelExporter { export type DataGridCell = common.Export.excel.DataGridCell; export type ExcelExportDataGridProps = common.Export.excel.DataGridExportOptions; export type ExcelExportPivotGridProps = common.Export.excel.PivotGridExportOptions; export const exportDataGrid: typeof common.Export.excel.exportDataGrid; export const exportPivotGrid: typeof common.Export.excel.exportPivotGrid; export type PivotGridCell = common.Export.excel.PivotGridCell; } declare namespace DevExpress.pdfExporter { export type Cell = common.Export.pdf.Cell; export type DataGridCell = common.Export.pdf.DataGridCell; export const exportDataGrid: typeof common.Export.pdf.exportDataGrid; export const exportGantt: typeof common.Export.pdf.exportGantt; export type PdfExportDataGridProps = common.Export.pdf.DataGridExportOptions; export type PdfExportGanttFont = common.Export.pdf.GanttExportFont; export type PdfExportGanttProps = common.Export.pdf.GanttExportOptions; } declare namespace DevExpress.utils { export const getTimeZones: typeof common.core.environment.getTimeZones; export const initMobileViewport: typeof common.core.environment.initMobileViewport; export const cancelAnimationFrame: typeof common.core.animation.cancelAnimationFrame; export const requestAnimationFrame: typeof common.core.animation.requestAnimationFrame; } declare namespace DevExpress.ui { export type Format = common.core.localization.Format; } export default DevExpress;