Methods

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

Use the dxPieChart registered method to access the PieChart widget, as demonstrated in the code below.

var pieChart = $("#pieChartContainer").dxPieChart("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 slice to select it. Since the pointSelectionMode is set to multiple, more than one slice can be selected. To deselect all the slices, click the 'Clear selected points' 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.

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

Parameters:
fileName: String
The name of a destination file.
format: String
A required format.
Accepted 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.
See Also

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, you can show tooltips using the button below. When clicking the Show next tooltip button, the showTooltip() method of the next point in the order will be called. Access to this point is provided by the chart's getAllSeries() and the series' getAllPoints() methods.


                                    

                                    

getSeries()

Deprecated

Use the getAllSeries() method instead.

Provides access to the PieChart series.

Return Value: Object
The PieChart series.

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

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.

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.

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.

hideLoadingIndicator()

Conceals the loading indicator.

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

If you need to show the loading indicator, invoke the showLoadingIndicator() method.

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.

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 called not like the other methods. To call the instance() method, the following construction is used:

JavaScript
$("#pieChartContainer").dxPieChart("instance")

Use the button below to show the tooltip of the next point in order.


                                    

                                    

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.

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.

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

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

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


                                    

                                    

print()

Opens the browser's print window.

See Also

render()

Redraws the widget.

Normally, the widget will redraw itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, e.g., after the widget container is resized. For this purpose, call the render() method.

render(renderOptions)

Redraws a widget.

Parameters:
renderOptions: Object
An object containing rerendering 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
}
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()

Displays the loading indicator.

This method shows the loading indicator. To hide it, call 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.

Show Example:
jQuery

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