BuyLog In
DevExtreme
All docs
V 24.2
24.2
24.1
23.2
23.1
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
All docs
V24.2

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
24.2
24.1
23.2
23.1
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
Full-text search
Overview
Getting Started
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
Chat
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DateRangeBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Floating Action Button
Form
Funnel
Gallery
Gantt
HtmlEditor
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NumberBox
Pagination
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Scheduler
ScrollView
SelectBox
Slider
Sortable
Sparkline
Splitter
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
VectorMap
Common Types
animation
charts
AnimationEaseMode
AnnotationType
ArgumentAxisHoverMode
AxisScaleType
ChartsAxisLabelOverlap
ChartsColor
ChartsDataType
ChartsLabelOverlap
DashStyle
DiscreteAxisDivisionMode
Font
GradientColor
HatchDirection
LabelOverlap
LabelPosition
LegendHoverMode
LegendMarkerState
Palette
PaletteColorSet
PaletteExtensionMode
PointInteractionMode
PointSymbol
RelativePosition
ScaleBreakLineStyle
SeriesHoverMode
SeriesSelectionMode
SeriesType
ShiftLabelOverlap
TextOverflow
Theme
TimeInterval
ValueErrorBarDisplayMode
ValueErrorBarType
VisualRangeUpdateMode
WordWrap
ZoomPanAction
data
events
gauges
grids
ApplyValueMode
ButtonStyle
ButtonType
ComparisonOperator
DataStructure
DataType
DefaultOptionsRule
Direction
DragDirection
DragHighlight
EditorStyle
ExportFormat
FieldChooserLayout
FirstDayOfWeek
FloatingActionButtonDirection
Format
HorizontalAlignment
HorizontalEdge
LabelMode
MaskMode
Mode
Orientation
PageLoadMode
PageOrientation
Position
PositionAlignment
ScrollbarMode
ScrollDirection
ScrollMode
SearchMode
SelectAllMode
SimplifiedSearchMode
SingleMultipleAllOrNone
SingleMultipleOrNone
SingleOrMultiple
SingleOrNone
SliderValueChangeMode
SortOrder
StoreType
SubmenuShowMode
TabsIconPosition
TabsStyle
TextBoxPredefinedButton
TextEditorButtonLocation
ToolbarItemComponent
ToolbarItemLocation
TooltipShowMode
ValidationMessageMode
ValidationRule
ValidationRuleType
ValidationStatus
VerticalAlignment
VerticalEdge
Utilities
Data Binding
Data Validation
TypeScript Guides
Localization and Globalization
UI Customization
Integration Guides
DevExtreme CLI
Data Analytics and BI
.NET Backend Solutions
Advanced Topics
Troubleshooting
Migrate to the New Version

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web

jQuery/JS Common Types - charts

AnimationEaseMode

Specifies the animation easing mode.

Type:

Literal Union

Accepted Values: 'easeOutCubic' | 'linear'

Used in:

AnnotationType

Specifies whether the annotation displays text, an image, or a template.

Type:

Literal Union

Accepted Values: 'text' | 'image' | 'custom'

Used in:

ArgumentAxisHoverMode

Specifies chart elements to be highlighted when a user points to an axis label.

Type:

Literal Union

Accepted Values: 'allArgumentPoints' | 'none'

Used in:

AxisScaleType

Specifies the type of the axis.

Type:

Literal Union

Accepted Values: 'continuous' | 'discrete' | 'logarithmic'

Used in:

ChartsAxisLabelOverlap

Decides how to arrange axis labels when there is not enough space to display all of them.

Type:

Literal Union

Accepted Values: 'rotate' | 'stagger' | 'none' | 'hide'

Used in:

ChartsColor

Specifies the chart's color.

import { ChartsColor } from "devextreme/common/charts"
Type:

Object

ChartsDataType

Specifies the type of axis values.

Type:

Literal Union

Accepted Values: 'datetime' | 'numeric' | 'string'

Used in:

ChartsLabelOverlap

Specifies how the chart must behave when series point labels overlap.

Type:

Literal Union

Accepted Values: 'hide' | 'none' | 'stack'

Used in:

DashStyle

Sets a dash style for the chart elements.

Type:

Literal Union

Accepted Values: 'dash' | 'dot' | 'longDash' | 'solid'

Used in:

DiscreteAxisDivisionMode

Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels.

Type:

Literal Union

Accepted Values: 'betweenLabels' | 'crossLabels'

Used in:

Font

Font properties.

import { Font } from "devextreme/common/charts"
Type:

Object

GradientColor

Specifies colors on which gradient is based.

import { GradientColor } from "devextreme/common/charts"
Type:

Object

HatchDirection

Specifies the direction of hatching lines.

Type:

Literal Union

Accepted Values: 'left' | 'none' | 'right'

Used in:

LabelOverlap

Decides how to arrange scale/axis labels when there is not enough space to keep all of them.

Type:

Literal Union

Accepted Values: 'hide' | 'none'

Used in:

LabelPosition

Specifies a label position relative to the chart.

Type:

Literal Union

Accepted Values: 'columns' | 'inside' | 'outside'

Used in:

LegendHoverMode

Specifies what series elements to highlight when a corresponding item in the legend is hovered over.

Type:

Literal Union

Accepted Values: 'excludePoints' | 'includePoints' | 'none'

Used in:

LegendMarkerState

The marker's state.

Type:

Literal Union

Accepted Values: 'normal' | 'hovered' | 'selected'

Used in:

Palette

Sets the palette to be used for colorizing chart elements.

Type:

Literal Union

Accepted Values: 'Bright' | 'Harmony Light' | 'Ocean' | 'Pastel' | 'Soft' | 'Soft Pastel' | 'Vintage' | 'Violet' | 'Carmine' | 'Dark Moon' | 'Dark Violet' | 'Green Mist' | 'Soft Blue' | 'Material' | 'Office'

Used in:

PaletteColorSet

Returns a subset of palette colors.

Type:

Literal Union

Accepted Values: 'simpleSet' | 'indicatingSet' | 'gradientSet'

Used in:

PaletteExtensionMode

Specifies how to extend the palette when it contains less colors than the number of chart points/series.

Type:

Literal Union

Accepted Values: 'alternate' | 'blend' | 'extrapolate'

Used in:

PointInteractionMode

Specifies series elements to be highlighted when a user interacts with a series point.

Type:

Literal Union

Accepted Values: 'allArgumentPoints' | 'allSeriesPoints' | 'none' | 'onlyPoint'

Used in:

PointSymbol

Specifies which symbol should represent series points in scatter, line- and area-like series.

Type:

Literal Union

Accepted Values: 'circle' | 'cross' | 'polygon' | 'square' | 'triangle' | 'triangleDown' | 'triangleUp'

Used in:

RelativePosition

Specifies the position of a chart element on the plot.

Type:

Literal Union

Accepted Values: 'inside' | 'outside'

Used in:

ScaleBreakLineStyle

Specifies the scale breaks' line style.

Type:

Literal Union

Accepted Values: 'straight' | 'waved'

Used in:

SeriesHoverMode

Specifies series elements to be highlighted when a user points to a series.

Type:

Literal Union

Accepted Values: 'allArgumentPoints' | 'allSeriesPoints' | 'excludePoints' | 'includePoints' | 'nearestPoint' | 'none' | 'onlyPoint'

Used in:

SeriesSelectionMode

Specifies series elements to be highlighted when a user selects a series.

Type:

Literal Union

Accepted Values: 'allArgumentPoints' | 'allSeriesPoints' | 'excludePoints' | 'includePoints' | 'none' | 'onlyPoint'

Used in:

SeriesType

Sets the series type.

Type:

Literal Union

Accepted Values: 'area' | 'bar' | 'bubble' | 'candlestick' | 'fullstackedarea' | 'fullstackedbar' | 'fullstackedline' | 'fullstackedspline' | 'fullstackedsplinearea' | 'line' | 'rangearea' | 'rangebar' | 'scatter' | 'spline' | 'splinearea' | 'stackedarea' | 'stackedbar' | 'stackedline' | 'stackedspline' | 'stackedsplinearea' | 'steparea' | 'stepline' | 'stock'

Used in:

ShiftLabelOverlap

Specifies how a chart should behave when point/bar/item labels overlap.

Type:

Literal Union

Accepted Values: 'hide' | 'none' | 'shift'

Used in:

TextOverflow

Specifies how to arrange chart text elements that overflow their containers: hide, truncated them with ellipsis, or leave them as they are.

Type:

Literal Union

Accepted Values: 'ellipsis' | 'hide' | 'none'

Used in:

Theme

Sets the name of the theme the UI component uses.

Type:

Literal Union

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

Used in:

TimeInterval

Specifies various time intervals.

Type:

Literal Union

Accepted Values: 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'

Used in:

ValueErrorBarDisplayMode

Specifies whether error bars must be displayed in full or partially.

Type:

Literal Union

Accepted Values: 'auto' | 'high' | 'low' | 'none'

Used in:

ValueErrorBarType

Specifies how error bar values must be calculated.

Type:

Literal Union

Accepted Values: 'fixed' | 'percent' | 'stdDeviation' | 'stdError' | 'variance'

Used in:

VisualRangeUpdateMode

Specifies how the selected or visual range should behave when data is updated.

Type:

Literal Union

Accepted Values: 'auto' | 'keep' | 'reset' | 'shift'

Used in:

WordWrap

Specifies how to wrap texts that do not fit into a single line.

Type:

Literal Union

Accepted Values: 'normal' | 'breakWord' | 'none'

Used in:

ZoomPanAction

Specifies zoom or pan mode.

Type:

Literal Union

Accepted Values: 'zoom' | 'pan'

Used in: