React Chart Props

When adapting to small container size, the widget may hide its accessory elements, thus saving space for more valuable ones. The elements are being hidden in the following sequence.

1. Title
2. Export menu icon
3. Legend
4. Axis titles
5. Axis labels
6. Point labels (can be saved by setting the adaptiveLayout.keepLabels option to true)

To specify the widget's size small enough for the layout to begin adapting, use the height and width options of the adaptiveLayout object.

View Demo on JSFiddle

The Chart widget provides a built-in zooming capability. Technically, zooming is performed down the argument axis, that is, the widget focuses on a smaller range of arguments. At the same time, the visible range of values also changes. In this case, use the adjustOnZoom option to decide whether or not to adjust the value axis to the changed visible range of values.

Besides the built-in zooming, you can zoom the Chart widget using the RangeSelector widget. For details on this feature, see the Zooming and Scrolling Using RangeSelector topic.

See Also

• zoomingMode - enables zooming in the chart.
• zoomArgument(startValue, endValue) - zooms the chart in code.

The widget animate its elements at the beginning of its lifetime and when the data source changes.

The argumentAxis object, which is described here, configures the argument axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

This option accepts values from 0 to 1 excluding 0. The assigned value specifies the correlation between a bar and the empty space around it. A value close to 0 makes the bar very thin leaving a lot of space, and 1, conversely, makes the bar very thick leaving no space.

View Demo

See Also

• series.minBarSize - sets the minimal possible height for bars in a bar-like series.

The commonAxisSettings object, which is described here, specifies common settings for all axes in a chart. To configure a particular axis, use the argumentAxis or valueAxis object. Axis-specific settings override common settings.

A pane is a chart area containing series. If there are many series an a chart, they can be distributed between multiple panes.

The commonPaneSettings object, which is described here, specifies common settings for all panes in the chart. To specify options of an individual pane, use the objects of the panes array. Individual settings override common settings.

There are three ways to configure a series.

• The commonSeriesSettings object
  Specifies settings for all series in a chart.

• The commonSeriesSettings.%seriesType% (area, line, etc.) object
  Specifies settings for all series of the seriesType.

• An object in the series array
  Specifies settings for an individual series.

If the background of your page has a color different from white, assign this color to the containerBackgroundColor option to ensure that the widget will blend smoothly into your page. Certain widget elements, such as series points in the hovered state, will use this color when coordinating with the page.

See Also

• panes.backgroundColor - colors the background of the chart plot.

Crosshair is a pointer represented by two mutually-crossing lines stretched over the entire chart plot. The crosshair helps a user identify the values of the series points precisely. When enabled, the crosshair follows the cursor and snaps to the nearest series point.

To enable the crosshair, set the crosshair.enabled option to true. Assign true to the crosshair.label.visible option as well to make the crosshair labels visible.

Settings specified in the crosshair object apply to both the crosshair lines. If you specify the same settings within the horizontalLine or verticalLine object, they will apply to the particular crosshair line only. Note that individual settings override common ones.

View Demo

All point labels in a chart are identical by default, but you can specify a unique appearance for individual labels using the customizeLabel function. This function should return an object with options that will be changed for a certain label. See the label object for information about all options available for changing.

The customizeLabel function accepts an object providing information about the series point that the label belongs to. This object contains the following fields.

In the range bar and range area series, the value field is replaced by the following fields.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

View Demo

By default, all series points in a chart are identical, but you can specify a unique appearance for individual points using the customizePoint function. This function should return an object with options that will be changed for a certain point. See the point object for information about all options available for changing.

The customizePoint function accepts an object providing information about the series point. This object contains the following fields.

In the range bar and range area series, the value field is replaced by the following fields.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

View Demo

This option accepts one of the following:

• Array of objects
  A simple JavaScript array containing a collection of plain objects. See demo.

• URL
  A URL to JSON data or a service returning data in JSON format. See demo.

• DataSource or its configuration object
  A DataSource is an object that provides an API for data processing. Learn more about it from the Data Layer and DataSource Examples guides. See demo.

  NOTE

  Turn the DataSource's pagination off to prevent data from partitioning.

See Also

• argumentField | valueField
• getDataSource()

This option accepts the name of a pane from the panes array. The default pane displays all series with unspecified pane property. If defaultPane is undefined, the last pane in the panes array becomes the default.

You can configure this option in an ASP.NET MVC Control as follows:

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

If a value in a series equals to zero or is undefined, the bar visualizing this value will not be displayed on the chart making an empty space. If you need to fill this space by extending the neighbouring bars, set the equalBarWidth option to false.

View Demo

See Also

• barWidth - controls the width of bars when equalBarWidth is true.
• series.minBarSize - sets the minimal possible height for bars in a bar-like series.

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

• exportTo(fileName, format)
• print()
• DevExpress.viz.exportFromMarkup(markup, options)

Watch Video

The Chart widget can include a legend - an explanatory component that helps you identify a series. Each series is represented by an item on a Legend. An item marker identifies the series color. An item label displays the series title. To set the required position for a legend and its items, to customize the font settings for item labels, and to specify the size of item markers, use the properties of the legend configuration object. To learn more on the legend and its options, refer to the Legend topic.

When the widget visualizes local data, loading is instant. But when the widget is bound to a remote data source, loading may takes a considerable amount of time. To keep the viewer's attention, the widget can display a loading indicator.

To activate the loading indicator, assign true to the loadingIndicator.show option. Once data is loaded, the loading indicator will be hidden automatically.

See Also

• showLoadingIndicator()
• hideLoadingIndicator()

When defining a bubble series, you are required to specify a size field. The largest size value will be represented on the chart by the largest bubble. Its visual diameter will be calculated by the following formula.

d = maxBubbleSize * min(height, width)

Normally, the height and width from this formula equal the size of the widget container. However, when several panes are used in the widget, the height and width equal the pane size.

When defining a bubble series, you are required to specify a size field. The smallest size value will be represented on the chart by the smallest bubble. To set its visual diameter, specify the minBubbleSize option.

Oftentimes, series data contains negative values. Visualizing such data using stacked-like series may lead to unexpected results. To prevent situations of this kind, assign true to the negativesAsZeroes option, and the widget will count all negative values as zeroes.

When implementing a handling function, use the object passed to it as the parameter. You can find the value of the clicked label among fields of this object.

Alternatively, you can navigate to a specific URL when the argumentAxisClick event fires. For this purpose, assign this URL to the onArgumentAxisClick option.

See Also

• getAllSeries()
• getSeriesByName(seriesName)
• getSeriesByPos(seriesIndex)

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.

• id
  Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
• type
  Contains the type of the incident. This field equals "error" for errors or "warning" for warnings.
• args
  Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
• text
  Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
• widget
  Contains the name of the widget that produced the error or warning.
• version
  Contains the currently used version of the DevExtreme library.

You cannot access widget elements in this handler because it is executed before they are ready. Use the onDrawn handler instead.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series to which the clicked legend item belongs. To learn about series members you can use, refer to the description of the Series object.

Alternatively, you can navigate to a specific URL when the legendClick event fires. For this purpose, assign this URL to the onLegendClick option.

To learn more about handling click operations, and to see an example, refer to the Click Handling topic.

View Demo

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked series point. To learn about point's members that you can use, refer to the description of the Point object.

Alternatively, you can navigate to a specific URL when the pointClick event fires. For this purpose, assign this URL to the onPointClick option.

To learn more about how to handle click operations, and to see an example, refer to the Click Handling topic.

View Demo

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose hover state has been changed. To identify whether this point was hovered over or hovered out, call its isHovered() method. To discover point fields and methods, refer to the Point class description.

To learn more about how to handle hover operations, refer to the Hover Handling topic.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose selection state has been changed. To identify whether this point was selected or deselected, call its isSelected() method. To discover point fields and methods that you can use, refer to the Point class description.

To learn more about how to handle selection, refer to the Selection Handling topic.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked series. To learn about series members that you can use, refer to the description of the Series object.

Alternatively, you can navigate to a specific URL when the seriesClick event fires. For this purpose, assign this URL to the onSeriesClick option.

To learn more about handling click operations, and to see an example, refer to the Click Handling topic.

View Demo

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series whose hover state has been changed. To identify whether this series was hovered over or hovered out, call its isHovered() method. To discover series fields and methods, refer to the Series class description.

To learn more about how to handle hover operations, refer to the Hover Handling topic.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series whose selection state has been changed. To identify whether this series was selected or deselected, call its isSelected() method. To discover series fields and methods, refer to the Series class description.

To learn more about how to handle selection, refer to the Selection Handling topic.

The point's tooltip becomes invisible when a user hovers the mouse cursor over another series point. In addition, you can hide a tooltip in code, using the hideTooltip() method of the chart or point.

When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. To do this, implement a handling function and assign it to the onTooltipHidden option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip becomes hidden.

The point's tooltip appears when a user hovers the mouse cursor over the point. In addition, you can show a tooltip in code, using the showTooltip() method of the chart or point.

When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to the onTooltipShown option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip appears.

This handler is called when zooming or scrolling ends.

See Also

• zoomingMode - enables zooming in the chart.
• scrollingMode - enables scrolling in the chart.
• onZoomStart - a handler for the zoomStart event.

This handler is called when zooming or scrolling begins.

See Also

• zoomingMode - enables zooming in the chart.
• scrollingMode - enables scrolling in the chart.
• onZoomEnd - a handler for the zoomEnd event.

Use this property to set a predefined or custom palette. The colors listed in the specified palette will be used to draw chart series, their points, labels and tooltips. If the number of a series is greater than the number of colors in the palette, palette colors are repeated, but slightly modified.

You can override the color of individual series and their points, labels and tooltips by setting the color property of the corresponding object. In addition, you can define a custom palette to use in your charts. To learn how to do this, refer to the Palettes topic.

When using the widget as an ASP.NET MVC Control, you can specify this option using the VizPalette enum. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage, Violet, Carmine, DarkMoon, SoftBlue, DarkViolet and GreenMist.

A pane is a chart area containing series. If there are many series an a chart, they can be distributed between multiple panes.

Each object in the panes array configures a single pane. If you have several panes, we recommend you to name each pane in order to be able to refer to them afterwards.

View Demo

See Also

• commonPaneSettings - specifies common settings for all panes in a chart.
• series.pane - binds a series to a pane.
• defaultPane - specifies which pane must be used by default.

If you place the widget on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the widget elements may get mixed up or disappear. To solve this problem, set the pathModified option to true.

See Also

• DevExpress.viz.refreshPaths()

To set the points to highlight along with the selected point, set the series.point.selectionMode option.

To learn how to select a point, refer to the Selection Handling topic.

When using the widget as an ASP.NET MVC Control, specify this option using the ChartElementSelectionMode enum. This enum accepts the following values: Single and Multiple.

Multiple Point Selection Demo API - Select a Point Demo

When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.

Series point labels display series point values. If your chart contains several series with a large number of points in each, point labels may overlap. In this case, specify how the chart must resolve overlapping using the resolveLabelOverlapping option. To hide certain labels, set this option to 'hide'. Labels to be hidden will be determined automatically. If labels that overlap belong to series points that have the same argument, you can arrange these labels in a stack. For this purpose, set the resolveLabelOverlapping option to 'stack'.

When using the widget as an ASP.NET MVC Control, specify this option using the ChartResolveLabelOverlapping enum. This enum accepts the following values: None, Hide and Stack.

See Also

• commonAxisSettings.inverted - inverts the axes.

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

The scroll bar allows a user to scroll the chart. In order to use the scroll bar, you need to enable scrolling and zooming in your chart.

By default, the scroll bar is hidden. To make it visible, set the visible field of the scrollBar object to true. Using other fields of this object you can adjust the scroll bar appearance settings, including color, width and opacity.

View Demo

This option allows you to control the scrolling capability in your chart. By default, this capability is off. To make scrolling available on touch-enabled devices only, assign 'touch' to the scrollingMode option. In that case, a user will be able to scroll the chart using the flick gesture. If your chart is not supposed to be viewed on touch-enabled devices, but you still need scrolling to be enabled, assign 'mouse' to the scrollingMode option. In that case, a user will be able to scroll the chart by dragging. To enable scrolling for all devices, assign 'all' to the scrollingMode option.

Scrolling may also be performed using the scroll bar. To make it visible assign true to the visible option of the scrollBar object.

When using the widget as an ASP.NET MVC Control, specify this option using the ChartPointerType enum. This enum accepts the following values: Mouse, Touch, All and None.

View Demo

See Also

• zoomStart - an event that fires when scrolling or zooming begins.
• zoomEnd - an event that fires when scrolling or zooming ends.

A series represents a grouping of related data points. The most important characteristic of a series is its type, which determines a particular visual representation of data. You can find more details on each series type in the corresponding topics in the Series help section.

To define a single series, assign an object defining the series to the series configuration object. In the series' object, specify the series type, data source fields, the appearance of the series points and other options.

To show several series, specify series as an array of objects defining series. If you need to set similar values to properties of several series, use the commonSeriesSettings configuration object. It exposes the properties that can be specified for all series at once and for all series of a particular type at once. Note that the values specified for a series individually (in the series array) override the values that are specified for all series (in the commonSeriesSettings object).

To set the series elements to highlight when a series is selected, set the series selectionMode option.

To learn how to select a point, refer to the Selection Handling topic.

When using the widget as an ASP.NET MVC Control, specify this option using the ChartElementSelectionMode enum. This enum accepts the following values: Single and Multiple.

View Demo

In most cases, you can organize the array that is assigned to the chart's dataSource option in the following way.

[
    {arg: arg1Value, series1Value: val11, series2Value: val12, ...}
    {arg: arg2Value, series1Value: val21, series2Value: val22, ...}
    ...
    {arg: argNValue, series1Value: valN1, series2Value: valN2, ...}
]

Each object that is included in the array represents an argument value and the values of all series for this argument.

However, there are some scenarios in which you do not know exactly how many series will be added. In these cases, you will not be able to define the data source in the manner detailed above. Instead, define it in the following way.

[
    {seriesName: series1, arg: arg11Value, val: value11 }
    {seriesName: series1, arg: arg12Value, val: value12 }
    ...
    {seriesName: seriesM, arg: argM1Value, val: valueM1 }
    {seriesName: seriesM, arg: argM2Value, val: valueM2 }
    ...
]

If you define a data source in this manner, set the argument and value fields using the argumentField and valueField properties of the commonSeriesSettings configuration object (for all series at once). Then, define a template for the series using the seriesTemplate configuration object. Within this object, set the data source field that specifies the series name to the nameField option.

If you need to specify individual values for options of a particular series, assign a callback function to the customizeSeries option of the seriesTemplate object.

View Demo

The widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.

When synchronized, the ticks (or grid lines) of all the value axes in a pane are located on the same line.

A theme is a widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.

When using the widget as an ASP.NET MVC Control, specify this option using the VizTheme enum. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, Android5Light, IOS7Default, Win10Black and Win10White.

The widget's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title option. Otherwise, set this option to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

By default, a chart displays all series points. But there may be situations when displaying all the series points may affect chart performance. In this case, it is better to aggregate the series points rather than display all of them. For this purpose, set the useAggregation option to true. The aggregation is based on the median filter algorithm.

See Also

• Points Aggregation Demo: Financial Charts | Line Charts

The valueAxis object, which is described here, configures the value axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

View Demo

This option allows you to control the zooming capability in your chart. By default, this capability is off. To make zooming available on touch-enabled devices only, assign 'touch' to the zoomingMode option. In that case, a user will be able to zoom in/out of the chart using the spread/pinch gesture. If your chart is not supposed to be viewed on touch-enabled devices, but you still need zooming to be enabled, assign 'mouse' to the zoomingMode option. In this case, a user will be able to zoom the chart by rolling the mouse wheel. To enable zooming for all devices, assign 'all' to the zoomingMode option.

When using the widget as an ASP.NET MVC Control, specify this option using the ChartPointerType enum. This enum accepts the following values: Mouse, Touch, All and None.

View Demo

See Also

• zoomArgument(startValue, endValue) - zooms the chart in code.
• adjustOnZoom - specifies whether or not to adjust the value axis when zooming the widget.
• zoomStart - an event that fires when zooming or scrolling begins.
• zoomEnd - an event that fires when zooming or scrolling ends.