Configuration

This section describes properties that configure the contents, behavior and appearance of the Chart widget.

adaptiveLayout

Specifies adaptive layout options.

Type: Object

When adapting to a small screen or 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)

The widget will begin to adapt when its container shrinks beyond the height and width values specified in the adaptiveLayout object.

View Demo on JSFiddle

adjustOnZoom

Specifies whether or not to adjust the value axis when zooming the widget.

Type: Boolean
Default Value: true

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.

NOTE: This option is not supported when the argument axis is discrete.

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
Show Example:
AngularJS
Knockout
jQuery

In this example, you can zoom the Chart widget using the RangeSelector widget. Note that the value axis of the Chart widget adjusts itself to the selected range. To disable this feature of the value axis, click the check box under the widgets.


                                    

                                    

In this example, you can zoom the Chart widget using the RangeSelector widget. Note that the value axis of the Chart widget adjusts itself to the selected range. To disable this feature of the value axis, click the check box under the widgets.


                                    

                                    

In this example, you can zoom the Chart widget using the RangeSelector widget. Note that the value axis of the Chart widget adjusts itself to the selected range. To disable this feature of the value axis, click the check box under the widgets.


                                    

                                    

animation

Specifies animation options.

Type: Object|Boolean

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

argumentAxis

Configures the argument axis.

Type: Object

DevExtreme HTML5 Charts Axis Axes

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.

barWidth

Controls the width of bars in the widget. Applies only to bar-like series and when the equalBarWidth option is true.

Type: Number
Default Value: undefined

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.

NOTE: When adapting to the small screen or container size, the widget may ignore this option.

See Also
  • series | minBarSize - sets the minimal possible height for bars in a bar-like series.
Show Example:
AngularJS
Knockout
jQuery

In this example, you can change the value of the barWidth option at runtime using the slider under the chart.


                                    

                                    

                                    

In this example, you can change the value of the barWidth option at runtime using the slider under the chart.


                                    

                                    

                                    

In this example, you can change the value of the barWidth option at runtime using the slider under the chart.


                                    

                                    

                                    

commonAxisSettings

Defines common settings for both the argument and value axis in a chart.

Type: Object

DevExtreme HTML5 Charts Axis Axes

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.

commonPaneSettings

Defines common settings for all panes in a chart.

Type: Object

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

DevExtreme HTML5 Charts GridLines

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.

commonSeriesSettings

Specifies settings common for all series in the chart.

Type: Object

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.

NOTE: You can use these objects together, but note that individual settings override type-specific settings, which in their turn, override common settings.

containerBackgroundColor

Colors the background of the chart container.

Type: String
Default Value: '#FFFFFF'

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

crosshair

Configures the crosshair feature.

Type: Object

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.

DevExtreme HTML5 Charts Crosshair

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

customizeLabel

Customizes the appearance of an individual point label.

Type: function(pointInfo)
Function parameters:
pointInfo: Object
Information defining the series point the label belongs to.
Return Value: Label configuration
A configuration object for the point label.

By default, all point labels in a chart are identical, 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.

Field Description
argument The argument of the series point.
value The value of the series point.
tag The tag of the series point.
seriesName The name of the series that includes the series point.
index The index of the series point in the points array.

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

Field Description
rangeValue1 The first value of the series point.
rangeValue2 The second value of the series point.

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

Field Description
openValue The open value of the series point.
closeValue The close value of the series point.
lowValue The low value of the series point.
highValue The high value of the series point.
reductionValue The reduction value of the series point.

NOTE: All fields listed in this description are also exposed by the this object.

View Demo

customizePoint

Customizes the appearance of an individual series point.

Type: function(pointInfo)
Function parameters:
pointInfo: Object
Information defining the series point.
Return Value: Point configuration
A configuration object for the point.

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.

NOTE: The hoverMode and selectionMode options cannot be changed using the customizePoint function, because they do not have anything to do with the appearance of series points.

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

Field Description
argument The argument of the series point.
value The value of the series point.
tag The tag of the series point.
seriesName The name of the series that includes the series point.
index The index of the series point in the points array.

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

Field Description
rangeValue1 The first value of the series point.
rangeValue2 The second value of the series point.

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

Field Description
openValue The open value of the series point.
closeValue The close value of the series point.
lowValue The low value of the series point.
highValue The high value of the series point.
reductionValue The reduction value of the series point.

NOTE: All fields listed in this description are also exposed by the this object.

View Demo

dataPrepareSettings

Processes data before visualizing it.

Type: Object

dataSource

Specifies the origin of data for the widget.

Cannot be used in themes.

This option accepts one of the following.

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

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

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE: When using a DataSource object, turn the pagination off to prevent data from partitioning.

See Also
  • series | argumentField - specifies which data source field provides arguments for series points.
  • series | valueField - specifies which data source field provides values for series points.
  • Data Layer - goes over the basics of the DataSource and Store concepts.
  • Data Source Examples - gives examples of how to implement a DataSource.

defaultPane

Specifies which pane should be used by default.

Type: String
Default Value: undefined
Cannot be used in themes.

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.

equalBarWidth

Specifies whether all bars should have equal width, even if some values are missing from a series. Applies only to bar-like series.

Type: Boolean
Default Value: true

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.

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.
Show Example:
AngularJS
Knockout
jQuery

In this example, the "Brazil" and "China" series miss one value each. Click the check box under the chart to change the value of the equalBarWidth option, and note how the appearance of these series changes in response.


                                    

                                    

In this example, the "Brazil" and "China" series miss one value each. Click the check box under the chart to change the value of the equalBarWidth option, and note how the appearance of these series changes in response.


                                    

                                    

In this example, the "Brazil" and "China" series miss one value each. Click the check box under the chart to change the value of the equalBarWidth option, and note how the appearance of these series changes in response.


                                    

                                    

export

Configures the exporting and printing features.

Type: Object

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.

NOTE: IE9 and Safari on Mac OS do not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the proxyUrl option description.

See Also

Watch Video

legend

Specifies the options of a chart's legend.

Type: Object

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.

Show Example:
jQuery

In this example, the legend's horizontalAlignment and verticalAlignment options are changed.


                                    

                                    

loadingIndicator

Configures the loading indicator.

Type: Object

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.

DevExtreme HTML5 Charts LoadingIndicator

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

margin

Generates space around the widget.

Type: Object

WidgetMargin DevExtreme ChartJS

maxBubbleSize

Specifies a coefficient determining the diameter of the largest bubble.

Type: Number
Default Value: 0.2
This member is exposed by the following entities:

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.

minBubbleSize

Specifies the diameter of the smallest bubble measured in pixels.

Type: Number
Default Value: 12
This member is exposed by the following entities:

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.

negativesAsZeroes

Forces the widget to treat negative values as zeroes. Applies to stacked-like series only.

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.

onArgumentAxisClick

A handler for the argumentAxisClick event.

Type: function(e) |String
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
argument: Date|Number|String
The argument axis.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, the argument axis' labels respond to click.


                                    

                                    

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE: The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onDone

A handler for the done event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

onDrawn

A handler for the drawn event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

Assign a callback function to this option if you need to perform specific actions when the widget has finished drawing itself. When implementing this function, you can access the drawn widget using the function's parameter.

onExported

A handler for the exported event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

To perform a custom action after data from the widget is exported, assign a function to this option. For example, this function can notify the user that the exporting has been completed. Within this function, you can use the object passed to it as the parameter.

See Also
  • export - configures client-side export and printing.
  • onExporting - allows you to request exporting details and prevent exporting.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onExporting

A handler for the exporting event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in Knockout and AngularJS approaches.
fileName: String
The name of the file to which the widget is about to be exported.
cancel: Boolean
Assign true to this field if you need to prevent exporting.
Default Value: null

To perform a custom action before data from the widget is exported, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel exporting.

See Also
  • export - configures client-side export and printing.
  • onExported - allows you to notify an end user when exporting is completed.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onFileSaving

A handler for the fileSaving event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
fileName: String
The name of the file to be saved.
format: String
The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
data: BLOB
Exported data as a BLOB.
cancel: Boolean
Assign true to this field if you need to prevent the file from being saved.
Default Value: null

To perform a custom action before a file with exported data is saved on the user's local storage, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel file saving.

See Also
  • export - configures client-side export and printing.
  • onExporting - allows you to request exporting details and prevent exporting.
  • onExported - allows you to notify an end user when exporting is completed.

onIncidentOccurred

A handler for the incidentOccurred event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Object
Information about the occurred incident.

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 ChartJS library.
Show Example:
jQuery

In this example, the type of the argument axis values is 'numeric'. Change it to 'string' using the drop-down list below the chart to induce an error. Information about the error will be displayed.


                                    

                                    

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onLegendClick

A handler for the legendClick event.

Type: function(e) |String
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Series
The series to which the clicked legend item belongs.
Cannot be used in themes.

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

Show Example:
jQuery

Click one of the legend items, and the information on the maximum value in the series corresponding to this legend item will appear below.


                                    

                                    

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

Show Example:
jQuery

In this example, use the checkbox below to change the legend's visibility. When you change it, the optionChanged event handler puts information on this event to the container at the bottom.


                                    

                                    

                                    

onPointClick

A handler for the pointClick event.

Type: function(e) |String
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Point
The clicked series point.
Cannot be used in themes.

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.

NOTE: A click on a series point causes the seriesClick event to fire after the pointClick event. To prevent this behavior, assign true to the jQueryEvent.cancel field of the object passed to the pointClick event handler as the argument.

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

Show Example:
jQuery

Click one of the points on the chart, and a message with the data on this point will appear below.


                                    

                                    

onPointHoverChanged

A handler for the pointHoverChanged event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose hover state has been changed.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, when a point on the chart is hovered over, the pie chart displays the information about the Olympic medals won by the US team in the year corresponding to the hovered point. When none of the chart points are hovered, the pie chart displays the information about medals won by this team overall.


                                    

                                    

onPointSelectionChanged

A handler for the pointSelectionChanged event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose selection state has been changed.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, click a point on the chart to select/unselect all points with the same argument. When the points are selected, the pie chart displays the information about the Olympic medals won by the US team in the year corresponding to the selected points. When none of the chart points are selected, the pie chart displays the information about medals won by this team overall.


                                    

                                    

onSeriesClick

A handler for the seriesClick event.

Type: function(e) |String
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Series
The clicked series.
Cannot be used in themes.

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.

NOTE: The seriesClick also fires when a user clicks a series point or a legend item, but only if it is not canceled in the pointClick and legendClick event handlers.

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

Show Example:
jQuery

Click one of the series on the chart, and the information on the maximum value in this series will appear below.


                                    

                                    

onSeriesHoverChanged

A handler for the seriesHoverChanged event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Series
The series whose hover state has been changed.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, when a series on the chart is hovered over, the pie chart displays the information about the population in the year corresponding to the hovered series. When none of the chart series is hovered, the pie chart displays the information about the population by year overall.


                                    

                                    

onSeriesSelectionChanged

A handler for the seriesSelectionChanged event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Series
The series whose selection state has been changed.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, click a series on the chart to select/deselect it. When the chart series is selected, the pie chart displays the information about the population in the year corresponding to the selected series. When none of the chart series is selected, the pie chart displays the information about the population by year overall.


                                    

                                    

onTooltipHidden

A handler for the tooltipHidden event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose tooltip becomes hidden.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, when a tooltip is made hidden, the function assigned to the onTooltipHidden option is called. This function displays a message with the corresponding content.


                                    

                                    

onTooltipShown

A handler for the tooltipShown event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose tooltip appears.
Cannot be used in themes.

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.

Show Example:
jQuery

In this example, when a tooltip is shown, the function assigned to the onTooltipShown option is called. This function displays a message with the corresponding content.


                                    

                                    

onZoomEnd

A handler for the zoomEnd event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
rangeStart: Date|Number
The value that became the start of the argument axis after zooming or scrolling ended.
rangeEnd: Date|Number
The value that became the end of the argument axis after zooming or scrolling ended.
Cannot be used in themes.

This handler is called when zooming or scrolling ends.

See Also

onZoomStart

A handler for the zoomStart event.

Type: function(e)
Function parameters:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

This handler is called when zooming or scrolling begins.

See Also

palette

Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart.

Type: Array|String
Default Value: 'Default'
Accepted Values: 'Default' | 'Soft Pastel' | 'Harmony Light' | 'Pastel' | 'Bright' | 'Soft' | 'Ocean' | 'Vintage' | 'Violet'

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.

Show Example:
jQuery

This example shows how to create a custom palette and apply it to a chart.


                                    

                                    

panes

Declares a collection of panes.

Type: Object|Array
Cannot be used in themes.

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

DevExtreme HTML5 Charts 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.

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.

pathModified

Notifies a widget that it is embedded into an HTML page that uses a path modifier.

Type: Boolean
Default Value: false
Cannot be used in themes.

If you place a widget on a page that uses a path modifier, notify the widget about it by setting the pathModified option to true. As an example of such modifiers, the base HTML tag can be considered. Also, we recommend you enable this option if you place the widget inside the <iframe> tag.

pointSelectionMode

Specifies whether a single point or multiple points can be selected in the chart.

Type: String
Default Value: 'single'
Accepted Values: 'single' | 'multiple'

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.

View Demo

Show Example:
jQuery

In this example, click a point to select/deselect this point. The pointSelectionMode option is set to multiple so that you can select multiple points. When selecting a point, the Total value of selected points number represented below is changed. Click the Clear selected points button to deselect all points at once.


                                    

                                    

redrawOnResize

Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.

Type: Boolean
Default Value: true
Cannot be used in themes.

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

NOTE: To redraw the widget after the size of its container has changed, call the render() method of the widget instance.

resolveLabelOverlapping

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

Type: String
Default Value: 'none'
Accepted Values: 'none' | 'hide' | 'stack'

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'.

rotated

Swaps the axes around making the value axis horizontal and the argument axis vertical.

Type: Boolean
Default Value: false
See Also
  • commonAxisSettings | inverted - inverts the axes.
Show Example:
AngularJS
Knockout
jQuery

In this example, click the check box under the chart to rotate the chart.


                                    

                                    

In this example, click the check box under the chart to rotate the chart.


                                    

                                    

In this example, click the check box under the chart to rotate the chart.


                                    

                                    

rtlEnabled

Specifies whether or not the widget supports right-to-left representation.

Type: Boolean
Default Value: false
Cannot be used in themes.

The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.

Show Example:
jQuery

The text In this example is written in the Arabic language with the right-to-left reading order enabled. Note that the legend marker and the minus sign of the negative numbers are at the right.


                                    

                                    

scrollBar

Specifies the settings of the scroll bar.

Type: Object

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

scrollingMode

Enables scrolling in your chart.

Type: String
Default Value: 'none'
Accepted Values: 'none' | 'touch' | 'mouse' | 'all'

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.

NOTE: In many cases, scrolling is useless without zooming, and vice versa. Hence, when enabling the scrolling capability in your chart, consider enabling the zooming capability as well.

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

View Demo

series

Specifies options for Chart widget series.

Type: Object|Array
Default Value: undefined
Cannot be used in themes.

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).

NOTE: This option is necessary. If you do not need to specify any of the options within the series object (e.g., when you have specified them within the commonSeriesSettings object), assign at least an empty object to the series field.

Show Example:
jQuery

seriesSelectionMode

Specifies whether a single series or multiple series can be selected in the chart.

Type: String
Default Value: 'single'
Accepted Values: 'single' | 'multiple'

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.

View Demo

Show Example:
jQuery

In this example, the seriesSelectionMode option is set to multiple. Click a series on the chart to select/deselect this series.


                                    

                                    

seriesTemplate

Defines options for the series template.

Type: Object
Default Value: undefined
Cannot be used in themes.

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

size

Specifies the size of the widget in pixels.

Type: Object
Default Value: undefined

By default, the widget occupies the entire area of the parent container. If you need to set a particular size for the widget, different from the container's size, assign a height and width in pixels to height and width properties of the size object.

Using the size object, you can hide the widget. For this purpose, simply assign 0 to both the height and width of the widget.

Show Example:
jQuery

In this example, the size of the chart is set smaller than the size of the chart container using the size option.


                                    

                                    

synchronizeMultiAxes

Indicates whether or not to synchronize value axes when they are displayed on a single pane.

Type: Boolean
Default Value: true

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

Show Example:
jQuery

In this example, a multi-axes chart is displayed. Toggle the check box below to choose whether or not to synchronize the labels of the value axes.


                                    

                                    

theme

Sets the name of the theme to be used in the widget.

Type: String
Default Value: 'generic.light'
Accepted Values: 'generic.light' | 'generic.dark' | 'generic.contrast' | 'android5.light' | 'ios7.default' | 'win10.black' | 'win10.white'

Use this property to set a predefined or custom theme. The options defining chart appearance will be set to the values that are set in the specified theme. You can override some of these values within the chart's configuration object.

NOTE: The following themes were deprecated or renamed: 'desktop', 'desktop-dark', 'android', 'android-holo-light', 'ios', 'win8', 'win8-white', 'win8.white', 'win8.black'. In new applications, use themes listed in the accepted values.

Show Example:
jQuery

In this example, a custom theme is defined on the base of the 'generic.light' theme and then applied.


                                    

                                    

title

Specifies the widget title.

Type: Object|String

Use this property to set the text to be displayed as the widget title. If you need to specify the title's position in the widget, assign an object to the title property with the required fields specified. In this instance, set the title's text using the text property.

The widget can display additional text in the subtitle. It is placed under the title. Use properties of the subtitle object to assign a text to the subtitle and change its font.

Show Example:
jQuery

In this example, the title text is assigned directly to the title field.


                                    

                                    

tooltip

Configures tooltips.

Type: 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.

Show Example:
jQuery

In this example, tooltips are enabled. Hover over any point to see a tooltip.


                                    

                                    

useAggregation

Specifies whether or not to filter the series points depending on their quantity.

Type: Boolean
Default Value: false

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.

View Demo

Show Example:
jQuery

In this example, the data source is populated with 5000 random values. You can change the value of the useAggregation option using the check box below.


                                    

                                    

valueAxis

Configures the value axis.

Type: Object|Array

DevExtreme HTML5 Charts Axis Axes

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

zoomingMode

Enables zooming in your chart.

Type: String
Default Value: 'none'
Accepted Values: 'none' | 'touch' | 'mouse' | 'all'

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.

NOTE: In many cases, zooming is useless without scrolling, and vice versa. Hence, when enabling the zooming capability in your chart, consider enabling the scrolling capability as well.

See Also

View Demo