Methods

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

Use the dxChart registered method to access the dxChart object as demonstrated in the code below.

JavaScript
var chart = $("#chartContainer").dxChart("instance");

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.

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.

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.


                                    

                                    

element()

Returns the root HTML element of the widget.

Return Value: jQuery
The root element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.

getAllSeries()

Returns an array of all series in the chart.

Return Value: Array
The series from the chart's series collection.

To learn about series members you can use, refer to the description of the Series object.

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.


                                    

                                    

getSeriesByName(seriesName)

Gets a series within the chart's series collection by the specified name (see the name option).

Parameters:
seriesName: String
The name of the series to be found.
Return Value: Object
The series that is found by the specified name.

If a series with the specified name is not found, the method returns null.

To learn about series members you can use, refer to the description of the Series object.

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 within the chart's series collection by its position number.

Parameters:
seriesIndex: Number
The index of the series to be found within the chart's series collection.
Return Value: Object
The series that is found by the specified position index.

Series in the chart's series collection are arranged as they are defined in the series array of the chart's configuration object. Note that the series are numbered from zero in the series collection.

To learn about series' members that you can use, refer to the description of the Series object.

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 size of the widget.

Return Value: Object
The current size of the widget.

Use this method to obtain the current size of the widget. The object returned by this method has the following fields.

  • width
    The width of the widget in pixels.
  • height
    The height of the widget in pixels.
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()

Conceals the loading indicator.

Although the loading indicator hides automatically when a chart is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.

To show the loading indicator, invoke the showLoadingIndicator() method.

Show Example:
jQuery

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


                                    

                                    

hideTooltip()

Hides all widget tooltips.

Use this method to hide all widget tooltips programmatically.

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

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

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 the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.
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 the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.
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 a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
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 the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

Use this method to subscribe to several events at 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()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

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 the specified configuration option of this component.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

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)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

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)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

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.


                                    

                                    

render(renderOptions)

Redraws a widget.

Parameters:
renderOptions: Object
An object containing rerendering options.

By default, a widget rerenders when the size of the parent window is changed. But there may be situations when a chart must be rerendered manually, i.e., when the size of the chart's container is changed or the container's visibility state is changed. To rerender the widget, use the render method.

Call the render method without a parameter after the size or visibility of the chart's container is changed. Alternatively, call the render method with an options object as the parameter. This object should contain the force field set to 'true'. In addition, you can use this object to specify whether or not to perform animation on rerendering with the animate field, and whether or not to rerender the chart in an asynchronous mode with the asyncSeriesRendering field.

The following code sample illustrates the example of the object to be passed as the renderOptions parameter.

JavaScript
var renderOptions = {
    force: true,
    animate: false,
    asyncSeriesRendering: false
}
Show Example:
jQuery

In this example, click the Change the container size button to call the render() method.


                                    

                                    

showLoadingIndicator()

Displays the loading indicator.

The loading indicator does not appear automatically. In order to display it, the showLoadingIndicator() method should be invoked.

To hide the loading indicator from code, use the hideLoadingIndicator() method.

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

Returns the widget's SVG markup.

Return Value: String
The widget's SVG markup.
NOTE
This method does not support Internet Explorer 8.
Show Example:
jQuery

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


                                    

                                    

zoomArgument(startValue, endValue)

Sets the specified start and end values for the chart's argument axis.

Parameters:
startValue: Number|Date|String
A new start value for the argument axis.
endValue: Number|Date|String
A new end value for the argument axis.

This function can be used when implementing zooming for your chart. If your chart is integrated with the dxRangeSelector 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

Show Example:
jQuery

In this example, the dxRangeSelector widget interacts with the dxChart widget. Choose a range in the range selector to zoom the chart to this range. The zooming is performed using the chart's zoomArgument(startValue, endValue) method.