JavaScript/jQuery PieChart Methods

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

format:

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

NOTE

Safari on Mac OS does not implement an API for saving files, but you can set up a server-side proxy.

View Demo

getAllSeries()

Gets all the series.

Return Value:

Array<Series>

The Series objects.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the widget's dataSource option was given a simple array.

getInnerRadius()

Gets the radius of the doughnut hole in pixels. Applies only when the type is "doughnut" or "donut".

Return Value:

Number

The radius of the doughnut hole.

getInstance(element)

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

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the PieChart instance found in an element with the myPieChart ID:

// Modular approach
import PieChart from "devextreme/viz/pie_chart";
...
let element = document.getElementById("myPieChart");
let instance = PieChart.getInstance(element) as PieChart;

// Non-modular approach
let element = document.getElementById("myPieChart");
let instance = DevExpress.viz.dxPieChart.getInstance(element);

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.

getSeriesByPos(seriesIndex)

Gets a series with a specific index.

Parameters:

seriesIndex:

Number

The series' index.

Return Value:

Series

The Series object.

getSize()

Gets the current widget size.

Return Value:

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.

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.

hideTooltip()

Hides all widget tooltips.

Use this method to hide all widget tooltips programmatically.

instance()

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

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

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

on(events)

Subscribes to events.

Parameters:

events:

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

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

print()

Opens the browser's print window.

View Demo

refresh()

Reloads data and repaints the widget.

The widget cannot track changes a third party makes in the data source. Call this method to update data in the widget in this case.

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.

render(renderOptions)

Redraws the widget.

Parameters:

renderOptions:

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.

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
}

resetOption(optionName)

Resets an option to its default value.

Parameters:

optionName:

An option's name.

showLoadingIndicator()

Shows the loading indicator.

svg()

Gets the widget's SVG markup.

Return Value: