DevExtreme v23.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Free Trial Buy

Common Types

animation

charts

data

events

gauges

grids

ApplyValueMode

Specifies the way an end-user applies the selected value.

Type:

Literal Union

Accepted Values: 'instantly' | 'useButtons'

ButtonStyle

Specifies how the button is styled.

Type:

Literal Union

Accepted Values: 'text' | 'outlined' | 'contained'

ButtonType

Specifies the button type.

Type:

Literal Union

Accepted Values: 'back' | 'danger' | 'default' | 'normal' | 'success'

ComparisonOperator

Specifies the operator to be used for comparing the validated value with the target.

Type:

Literal Union

Accepted Values: '!=' | '!==' | '<' | '<=' | '==' | '===' | '>' | '>='

DataStructure

Specifies the data structure.

Type:

Literal Union

Accepted Values: 'plain' | 'tree'

DataType

Specifies a data type for a column/field value.

Type:

Literal Union

Accepted Values: 'string' | 'number' | 'date' | 'boolean' | 'object' | 'datetime'

DefaultOptionsRule

Specifies the device-dependent default configuration properties for a component.

import { DefaultOptionsRule } from "devextreme/core/options"
Type:

Object

Direction

Specifies the animation direction for the "slideIn" and "slideOut" animation types.

Type:

Literal Union

Accepted Values: 'bottom' | 'left' | 'right' | 'top'

DragDirection

Specifies the directions in which an item/row can be dragged.

Type:

Literal Union

Accepted Values: 'both' | 'horizontal' | 'vertical'

DragHighlight

Specifies how to highlight the item/row's drop position.

Type:

Literal Union

Accepted Values: 'push' | 'indicate'

EditorStyle

Specifies how the UI component's text field is styled.

Type:

Literal Union

Accepted Values: 'outlined' | 'underlined' | 'filled'

ExportFormat

Specifies a set of export formats.

Type:

Literal Union

Accepted Values: 'GIF' | 'JPEG' | 'PDF' | 'PNG' | 'SVG'

FieldChooserLayout

Specifies the field chooser layout.

Type:

Literal Union

Accepted Values: 0 | 1 | 2

FirstDayOfWeek

Specifies the first day of a week.

Type:

Literal Union

Accepted Values: 0 | 1 | 2 | 3 | 4 | 5 | 6

FloatingActionButtonDirection

Specifies the direction in which to open the speed dial menu.

Type:

Literal Union

Accepted Values: 'auto' | 'up' | 'down'

Format

Specifies a predefined format.

Type:

Literal Union

Accepted Values: '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'

HorizontalAlignment

Specifies a position in the horizontal direction.

Type:

Literal Union

Accepted Values: 'center' | 'left' | 'right'

HorizontalEdge

Specifies the position of a component's element relative to the component in the horizontal direction.

Type:

Literal Union

Accepted Values: 'left' | 'right'

LabelMode

Specifies the label's display mode.

Type:

Literal Union

Accepted Values: 'static' | 'floating' | 'hidden'

MaskMode

Specifies when the UI component shows the mask.

Type:

Literal Union

Accepted Values: 'always' | 'onFocus'

Mode

Specifies an 'auto' mode.

Type:

Literal Union

Accepted Values: 'auto'

Orientation

Specifies whether the UI component is oriented horizontally or vertically.

Type:

Literal Union

Accepted Values: 'horizontal' | 'vertical'

PageLoadMode

Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the "next" button is clicked.

Type:

Literal Union

Accepted Values: 'nextButton' | 'scrollBottom'

PageOrientation

Specifies the page orientation.

Type:

Literal Union

Accepted Values: 'portrait' | 'landscape'

Position

Specifies the position of the component's element.

Type:

Literal Union

Accepted Values: 'bottom' | 'left' | 'right' | 'top'

PositionAlignment

Positions the UI component.

Type:

Literal Union

Accepted Values: 'bottom' | 'center' | 'left' | 'left bottom' | 'left top' | 'right' | 'right bottom' | 'right top' | 'top'

ScrollbarMode

Specifies when the UI component shows the scrollbar.

Type:

Literal Union

Accepted Values: 'always' | 'never' | 'onHover' | 'onScroll'

ScrollDirection

Specifies the available scrolling directions.

Type:

Literal Union

Accepted Values: 'both' | 'horizontal' | 'vertical'

ScrollMode

Specifies the scrolling mode.

Type:

Literal Union

Accepted Values: 'standard' | 'virtual'

SearchMode

Specifies a comparison operation used to search UI component items.

Type:

Literal Union

Accepted Values: 'contains' | 'startswith' | 'equals'

SelectAllMode

Specifies the mode in which all items are selected.

Type:

Literal Union

Accepted Values: 'allPages' | 'page'

SimplifiedSearchMode

Specifies a comparison operation used to search UI component items.

Type:

Literal Union

Accepted Values: 'contains' | 'startswith'

SingleMultipleAllOrNone

Specifies whether the UI component enables an end-user to select only a single item, multiple items, all, or none.

Type:

Literal Union

Accepted Values: 'single' | 'multiple' | 'all' | 'none'

SingleMultipleOrNone

Specifies whether the UI component enables an end-user to select only a single item, multiple items, or none.

Type:

Literal Union

Accepted Values: 'single' | 'multiple' | 'none'

SingleOrMultiple

Specifies whether the UI component enables an end-user to select only a single item or multiple items.

Type:

Literal Union

Accepted Values: 'single' | 'multiple'

SingleOrNone

Specifies whether the UI component enables an end-user to select only a single item or none.

Type:

Literal Union

Accepted Values: 'single' | 'none'

SliderValueChangeMode

Specifies when to change the component's value.

Type:

Literal Union

Accepted Values: 'onHandleMove' | 'onHandleRelease'

SortOrder

Specifies the sort order of column, header, field, or group summary values.

Type:

Literal Union

Accepted Values: 'asc' | 'desc'

StoreType

Specifies the storage type the DataSource uses.

Type:

Literal Union

Accepted Values: 'array' | 'local' | 'odata'

SubmenuShowMode

Specifies modes of submenu showing and hiding.

Type:

Literal Union

Accepted Values: 'onClick' | 'onHover'

TextBoxPredefinedButton

Specifies the predefined button for a textbox.

Type:

Literal Union

Accepted Values: 'clear'

TextEditorButtonLocation

Specifies whether to place the button before or after the input text field.

Type:

Literal Union

Accepted Values: 'after' | 'before'

ToolbarItemComponent

Specifies the UI component that presents a toolbar item.

Type:

Literal Union

Accepted Values: 'dxAutocomplete' | 'dxButton' | 'dxCheckBox' | 'dxDateBox' | 'dxMenu' | 'dxSelectBox' | 'dxTabs' | 'dxTextBox' | 'dxButtonGroup' | 'dxDropDownButton'

ToolbarItemLocation

Specifies a location for the item on the toolbar.

Type:

Literal Union

Accepted Values: 'after' | 'before' | 'center'

TooltipShowMode

Specifies when the UI component shows a tooltip.

Type:

Literal Union

Accepted Values: 'always' | 'onHover'

ValidationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

Literal Union

Accepted Values: 'always' | 'auto'

ValidationRule

Specifies a validation rule.

import { ValidationRule } from "devextreme/common"
Type:

AsyncRule

|

CompareRule

|

CustomRule

|

EmailRule

|

NumericRule

|

PatternRule

|

RangeRule

|

RequiredRule

|

StringLengthRule

ValidationRuleType

Specifies the validation rule type.

Type:

Literal Union

Accepted Values: 'required' | 'numeric' | 'range' | 'stringLength' | 'custom' | 'compare' | 'pattern' | 'email' | 'async'

ValidationStatus

Specifies the validation status.

Type:

Literal Union

Accepted Values: 'valid' | 'invalid' | 'pending'

VerticalAlignment

Specifies a position in the vertical direction.

Type:

Literal Union

Accepted Values: 'bottom' | 'center' | 'top'

VerticalEdge

Specifies the position of a component's element relative to the component in the vertical direction.

Type:

Literal Union

Accepted Values: 'bottom' | 'top'