Methods

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

Use the dxPieChart registered method to access the dxPieChart object, 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.

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.

getSeries()

Provides access to the dxPieChart series.

Return Value:

Object

The dxPieChart series.

To learn about series members 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 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.

hideTooltip()

Hides all widget tooltips.

Use this method to hide all widget tooltips programmatically.

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.

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.

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.

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.

option(options)

Sets one or more options of this component.

Parameters:
options:

Object

An object containing the required configuration options.

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
}

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.

svg()

Returns the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

NOTE
This method does not support Internet Explorer 8.