Methods

This section describes the methods that can be used in code to manipulate the widget.

See Also

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

clearSelection()

Deselects the chart's selected series. The series is displayed in an initial style.

To learn about series selection, refer to the Selection Handling help section.

See Also
Show Example:
jQuery

In this example, click a series to select it. Since the seriesSelectionMode is set to multiple, more than one series can be selected. To deselect all the series, click the Clear selected series button. The chart's clearSelection() method will be called.


                                    

                                    

dispose()

Removes the widget from the DOM.

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget.

Parameters:
fileName:

String

The name of the file to which the widget is about to be exported.

format:

String

The file's format.
Possible values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | '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 export | proxyUrl option description.

View Demo

See Also

getAllSeries()

Gets all the series.

Return Value:

Array<Series>

The Series objects.

See Also
Show Example:
jQuery

In this example, click the Display series names button to call the getAllSeries() method and display the name of each chart series.


                                    

                                    

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the dataSource option of the widget was given a simple array.
See Also

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

The following code gets the Chart instance found in an element with ID myChart:

// Modular approach
import Chart from 'devextreme/ui/chart';
...
let element = document.getElementById("myChart");
let instance = Chart.getInstance(element);

// Non-modular approach
let element = document.getElementById("myChart");
let instance = DevExpress.ui.dxChart.getInstance(element);
See Also

getSeriesByName(seriesName)

Gets a series with a specific name.

Parameters:
seriesName: any

The series' name.

Return Value:

Series

The Series object; null if nothing is found.

See Also
Show Example:
jQuery

Enter the name of a series in the textbox and click the Display maximum value button. The getSeriesByName(seriesName) method will be called and the maximum value in the series with the specified name will be shown. If a series with the entered name does not exist, the corresponding message will be displayed.


                                    

                                    

getSeriesByPos(seriesIndex)

Gets a series with a specific index.

Parameters:
seriesIndex:

Number

The series' index.

Return Value:

Series

The Series object.

See Also
Show Example:
jQuery

Choose an index of the series using the set of radio buttons below and click the Display maximum value button to call the getSeriesByPos(seriesIndex) method. The maximum value in the series with the specified index will be displayed.


                                    

                                    

getSize()

Gets the current widget size.

Return Value: BaseWidgetOptions_size

The current widget size.

Returns an object with the following fields.

  • width
    The width of the widget in pixels.
  • height
    The height of the widget in pixels.
See Also
Show Example:
jQuery

In this example, the chart size is acquired using the getSize() function after the widget is drawn. The returned value is placed to the container at the bottom of the chart.


                                    

                                    

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the widget is ready, you can hide it from code at the required moment using this method.

See Also
Show Example:
jQuery

In this example, data is loaded with five seconds delay. You can show/hide the loading indicator using the buttons under the widget. Note that the loading indicator can be displayed or concealed manually at any time no matter whether the data is loaded or not.


                                    

                                    

hideTooltip()

Hides all widget tooltips.

Use this method to hide all widget tooltips programmatically.

See Also
Show Example:
jQuery

In this example, you can show and hide tooltips using the corresponding buttons below. When clicking the Show next tooltip button, the showTooltip() method of the next point in the order will be called. When clicking the Hide all tooltips button, the chart's hideTooltip() method will be called. This method clears the chart plot from tooltips.


                                    

                                    

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also
Show Example:
jQuery

In the following example, the instance() method is used to get access to the chart options. This method is not called like the other methods. To call the instance() method, the following construction is used:

<!--JavaScript -->$("#chartContainer").dxChart("instance")

Use the check box below to switch between the values of the commonAxisSettings | visible option.


                                    

                                    

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Object

The object for which this method is called.

See Also
Show Example:
jQuery

In this example, use the buttons below to subscribe different handlers to the pointHoverChanged event. One of the handlers displays information on a hovered point at the bottom of the chart, whereas the other one displays it using the dxToast widget. The Unsubscribe button calls the chart's off("pointHoverChanged") method, which clears the list of pointHoverChanged event subscribers.


                                    

                                    

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

Return Value:

Object

The object for which this method is called.

See Also
Show Example:
jQuery

In this example, use the buttons below for subscribing to and unsubscribing from the pointHoverChanged event. The event's handler displays information about the hovered point.


                                    

                                    

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

function

The event's handler.

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also
Show Example:
jQuery

In this example, use the buttons below for subscribing to and unsubscribing from the pointHoverChanged event. The event's handler displays information about the hovered point.


                                    

                                    

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also
Show Example:
jQuery

In this example, use the buttons below for subscribing to and unsubscribing from the pointHoverChanged and seriesHoverChanged events. The events' handlers display information about the hovered element of the chart.


                                    

                                    

option()

Gets all widget options.

Return Value:

Object

The widget's options.

Show Example:
jQuery

In this example, the option() method is used to obtain the value of the commonAxisSettings | visible option and display it under the chart. To change this value, use the check box below.


                                    

                                    

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

Show Example:
jQuery

In this example, the option(optionName) method is used to obtain the value of the tooltip | enabled option and display it under the chart. To change this value, use the check box below.


                                    

                                    

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

Show Example:
jQuery

In this example, the option(optionName, optionValue) method is used to set the value of the tooltip | enabled option at runtime. To change this value, use the check box below.


                                    

                                    

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

Show Example:
jQuery

In this example, the option(options) method is used to alter a set of options at once. To change the values of the tooltip | enabled and tooltip | arrowLength options, use the check box below.


                                    

                                    

print()

Opens the browser's print window.

render()

Redraws the widget.

Normally, the widget redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the widget's container is resized. For this purpose, call the render() method.

See Also

render(renderOptions)

Redraws the widget.

Parameters:
renderOptions:

Object

Rendering options.

You can call the render method without parameters after the size or visibility of the widget container is changed. Alternatively, call the render method passing an object as the parameter. This object must contain the force field set to 'true'. In addition, you can use this object to specify whether or not to perform animation on redrawing with the animate field, and whether or not to redraw the widget in an asynchronous mode with the asyncSeriesRendering field.

The following code sample illustrates the example of the object that can be passed to the render method.

JavaScript
var renderOptions = {
    force: true, // forces redrawing
    animate: false, // redraws the widget without animation
    asyncSeriesRendering: false // redraws the widget synchronously
}
See Also
Show Example:
jQuery

Click the 'Change the container size' button to switch between two sizes of the widget container. You can set the size either to 400x600 or 300x500 pixels. The render method without parameters is used to redraw the widget after the container size changes.


                                    

                                    

showLoadingIndicator()

Shows the loading indicator.

Show Example:
jQuery

In this example, the loading indicator is displayed until data is ready (5 seconds in this example). You can show and hide the loading indicator using the corresponding buttons below.


                                    

                                    

svg()

Gets the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

Show Example:
jQuery

Click the Get SVG below the chart, and the SVG copy of this chart will appear.


                                    

                                    

zoomArgument(startValue, endValue)

Sets the argument axis' start and end values.

Parameters:
startValue:

Number

|

Date

|

String

A new start value.

endValue:

Number

|

Date

|

String

A new end value.

This function can be used when implementing zooming for your chart. If your chart is integrated with the RangeSelector widget, call the zoomArgument function when the range selector's selected range is changed. Pass the start and end values of the range selector's selected range as the corresponding parameters of the function.

When the chart's adjustOnZoom option is set to true, the maximum and minimum values of the chart's value axis are changed to correspond to the maximum and minimum values of the chart's series. This is required to remove the empty area in the chart that may appear when changing the maximum and minimum values of the argument axis. To prevent value axis adjustment in response to argument axis boundary changes, set the adjustOnZoom option to false.

View Demo

See Also