JavaScript/jQuery PieChart Options

|

The widget animate its elements at the beginning of its lifetime and when the data source changes.

commonSeriesSettings

An object defining the configuration options that are common for all series of the PieChart widget.

Type:

Use this object's properties to set options for all chart series at once.

customizeLabel

Customizes the appearance of an individual point label.

Type:

Function parameters:

pointInfo:

Information on the series point.

Return Value:

Point Label

The label's configuration.

All point labels in a chart are identical by default, but you can specify a unique appearance for individual labels using the customizeLabel function. This function should return an object with options that will be changed for a certain label. See the label object for information about all options available for changing.

The customizeLabel function accepts an object providing information about the series point that the label belongs to. This object contains the following fields.

Field	Description
argument	The argument of the series point.
value	The value of the series point.
tag	The tag of the series point.
series	The series that includes the series point.
index	The index of the series point in the points array.

customizePoint

Customizes the appearance of an individual series point.

Type:

Function parameters:

pointInfo:

Information on the series point.

Return Value:

Point Configuration

The point's configuration.

By default, all the points of a pie are displayed identically. But you can specify different appearance for certain points using the customizePoint field. Assign a function to this field. This function should return an object with options that should be changed for a certain point. The following pie options can be changed.

When implementing a callback function for this option, use the argument or value of a point. They can be accessed using the following fields of the function's parameter.

argument
The argument of the point.
value
The value of the point.
tag
The tag of the point.
index
The index of the point in the points array.

In addition, these values can be accessed using the this object.

dataSource

Specifies the widget's data origin.

Type:

Array<any>

|

DataSource

|

DataSource Configuration

|

Cannot be used in themes.

This option accepts one of the following:

Array of objects
A simple JavaScript array containing a collection of plain objects. See demo.
URL
The URL of a JSON file or service that returns JSON data. See demo.
DataSource or its configuration object
A DataSource is an object that provides an API for data processing. Learn more about it from the Data Layer and DataSource Examples guides. See demo.

NOTE

Turn the DataSource's pagination off to prevent data from partitioning.

NOTE

Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

diameter

Specifies the diameter of the pie.

Type:

Default Value: undefined

This option accepts a number that identifies the ratio between the pie's diameter and the widget's width or height (depending on which of them is less). For example, assume that the widget's size is 300x500 pixels and the diameter option is set to 0.5. Then, the resulting diameter of the pie will be:

0.5 * min(300,500) = 0.5 * 300 = 150 pixels

disabled

Specifies whether the widget responds to the user interaction.

Type:

Default Value: false

Cannot be used in themes.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#pieChartContainer").dxPieChart({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-pie-chart ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-pie-chart>

import { DxPieChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxPieChartModule
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().PieChart()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().PieChart() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

export

Configures the exporting and printing features.

Type:

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

NOTE

Safari on Mac OS does not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the proxyUrl option description.

innerRadius

Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1.

Type:

Default Value: 0.5

Use this option to change the amount of space occupied by the inner area of the doughnut-type pie chart.

legend

Specifies PieChart legend options.

Type:

The PieChart widget can include a legend. It helps you distinguish and identify the points of the displayed series. Each point is presented by an item on the legend. An item marker identifies the point's (slice's) color. An item label displays a value corresponding to the point. Use the legend property to set up PieChart legend options to the required values. To learn more about the legend and its options, refer to the Legend topic.

loadingIndicator

Configures the loading indicator.

Type:

When the widget visualizes local data, loading is instant. But when the widget is bound to a remote data source, loading may takes a considerable amount of time. To keep the viewer's attention, the widget can display a loading indicator.

DevExtreme HTML5 Charts LoadingIndicator

To activate the loading indicator, assign true to the loadingIndicator.show option. Once data is loaded, the loading indicator will be hidden automatically.

margin

Generates space around the widget.

Type:

WidgetMargin DevExtreme ChartJS

minDiameter

Specifies the minimum diameter of the pie.

Type:

Default Value: 0.5

This option specifies the minimum ratio between the pie's diameter and the widget's width or height (depending on which of them is less). For example, assume that the widget's size is 300x500 pixels and the minDiameter option is 0.7. Then, the diameter of the pie will never be less than:

0.7 * min(300,500) = 0.7 * 300 = 210 pixels

NOTE

This option is ignored if the diameter option is set.

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Default Value: null

onDone

A function that is executed when all series are ready.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Default Value: null

Cannot be used in themes.

onDrawn

A function that is executed when the widget's rendering has finished.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Default Value: null

Cannot be used in themes.

onExported

A function that is executed after the widget is exported.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Default Value: null

onExporting

A function that is executed before the widget is exported.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
fileName	String	The name of the file to which the widget is about to be exported.
cancel	Boolean	Allows you to prevent exporting.
format	String	The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

Default Value: null

onFileSaving

A function that is executed before a file with exported widget is saved to the user's local storage.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
fileName	String	The name of the file to be saved.
format	String	The format of the file to be saved. Possible Values: 'PNG' \| 'PDF' \| 'JPEG' \| 'SVG' \| 'GIF'
data	BLOB	Exported data as a BLOB.
cancel	Boolean	Allows you to prevent file saving.

Default Value: null

onIncidentOccurred

A function that is executed when an error or warning occurs.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
target	any	Information on the occurred incident.

Default Value: null

The widget notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

id
The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
type
The incident's type: "error" or "warning".
args
The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the option that was not set properly.
text
The text passed to the browser's console. Includes the args content, if there is any.
widget
The name of the widget that produced the error or warning.
version
The used DevExtreme version.

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onDrawn function instead.

onLegendClick

A function that is executed when a legend item is clicked or tapped.

Type:

|

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
target	String \| Number	The argument of the point(s) corresponding to the clicked legend item.
points	Array<Point>	The Point object(s).

Default Value: null

Cannot be used in themes.

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	PieChart	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Default Value: null

onPointClick

A function that is executed when a series point is clicked or tapped.

Type:

|

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
target	Point	The clicked series point; described in the Point section.

Default Value: null

Cannot be used in themes.

View Demo

onPointHoverChanged

A function that is executed after the pointer enters or leaves a series point.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	Object	The widget's container.
target	Point	The series point whose hover state has been changed; described in the Point section.

Name

Type

Description

component

The widget's instance.

element

The widget's container.

target

Point

The series point whose hover state has been changed; described in the Point section.

Cannot be used in themes.

To identify whether the pointer has entered or left the series point, call the point's isHovered() method.

onPointSelectionChanged

A function that is executed when a series point is selected or the selection is canceled.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	Object	The widget's container.
target	Point	The series point whose selection state has been changed; described in the Point section.

Name

Type

Description

component

The widget's instance.

element

The widget's container.

target

Point

The series point whose selection state has been changed; described in the Point section.

Cannot be used in themes.

To identify whether the selection has been applied or canceled, call the point's isSelected() method.

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
target	Point	The series point whose tooltip is hidden; described in the Point section.

Default Value: null

Cannot be used in themes.

onTooltipShown

A function that is executed when a tooltip appears.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PieChart	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
target	Point	The series point whose tooltip is shown; described in the Point section.

Default Value: null

Cannot be used in themes.

palette

Sets the palette to be used to colorize series and their elements.

Type:

Array<String>

|

Default Value: 'Material'

This option accepts either the name of a predefined palette or an array of colors. The array can include the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors

Use the VizPalette enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage, Violet, Carmine, DarkMoon, SoftBlue, DarkViolet, and GreenMist.

paletteExtensionMode

Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart widget) or points in a series (in the PieChart widget).

Type:

Default Value: 'blend'

Accepted Values: 'alternate' | 'blend' | 'extrapolate'

The following variants are available:

"blend"
Create a blend of two neighboring colors and insert it between these colors in the palette.
"alternate"
Repeat the full set of palette colors, alternating their normal, lightened, and darkened shades in that order.
"extrapolate"
Repeat the full set of palette colors, changing their shade gradually from dark to light.

pathModified

Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.

Type:

Default Value: false

Cannot be used in themes.

If you place the widget on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the widget elements may get mixed up or disappear. To solve this problem, set the pathModified option to true.

pointSelectionMode

Specifies whether a single point or multiple points can be selected in the chart.

Type:

Default Value: 'single'

Accepted Values: 'multiple' | 'single'

To set the points to highlight along with the selected point, set the series.selectionMode option.

To learn how to select a point, refer to the Selection Handling topic.

Use the ChartElementSelectionMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Single and Multiple.

redrawOnResize

Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.

Type:

Default Value: true

Cannot be used in themes.

When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.

NOTE

To redraw the widget after the size of its container has changed, call the render() method of the widget's instance.

resolveLabelOverlapping

Specifies how a chart must behave when point labels overlap.

Type:

Default Value: 'none'

Accepted Values: 'hide' | 'none' | 'shift'

Series point labels display series point values. If the series in your pie chart contains a large number of points, point labels may overlap. In this case, specify how the chart must resolve overlapping using the resolveLabelOverlapping option. To hide certain labels, set this option to 'hide'. Labels to be hidden will be determined automatically. To resolve overlapping by shifting labels from their positions, set the resolveLabelOverlapping option to 'shift'. In this case, it is recommended that you display label connectors so that pie segments are connected with their labels. If there is not enough space for all labels after they are shifted, labels with the smallest values will be hidden.

NOTE

If the position option is set to "inside", the "shift" mode in label overlapping is not available.

Use the PieChartResolveLabelOverlapping enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: None, Hide, and Shift.

View Demo

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

Cannot be used in themes.

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

segmentsDirection

Specifies the direction that the pie chart segments will occupy.

Type:

Default Value: 'clockwise'

Accepted Values: 'anticlockwise' | 'clockwise'

Use the PieChartSegmentsDirection enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Clockwise and AntiClockwise.

series

Specifies options for the series of the PieChart widget.

Type:

Array<Series Configuration>

|

Default Value: undefined

Cannot be used in themes.

A series represents a group of related data points. To configure a series, assign an object to the series option. If PieChart must contain several series, assign an array of such objects to the same option. Refer to the Series Overview topic to learn the basics of what a series is, what it does, and how it helps.

The definitive characteristic of a series is its type. The PieChart widget provides two series types - Pie and Doughnut.

When you have a multi-series pie, settings that are common for all series can be specified all together. Use the commonSeriesSettings object to do this.

seriesTemplate

Defines options for the series template.

Type:

Default Value: undefined

Cannot be used in themes.

In most cases, you can organize the array that is assigned to the chart's dataSource option in the following way.

[
    {arg: arg1Value, series1Value: val11, series2Value: val12, ...}
    {arg: arg2Value, series1Value: val21, series2Value: val22, ...}
    ...
    {arg: argNValue, series1Value: valN1, series2Value: valN2, ...}
]

Each object that is included in the array represents an argument value and the values of all series for this argument.

However, there are some scenarios in which you do not know exactly how many series will be added. In these cases, you will not be able to define the data source in the manner detailed above. Instead, define it in the following way.

[
    {seriesName: series1, arg: arg11Value, val: value11 }
    {seriesName: series1, arg: arg12Value, val: value12 }
    ...
    {seriesName: seriesM, arg: argM1Value, val: valueM1 }
    {seriesName: seriesM, arg: argM2Value, val: valueM2 }
    ...
]

If you define a data source in this manner, set the argument and value fields using the argumentField and valueField properties of the commonSeriesSettings configuration object (for all series at once). Then, define a template for the series using the seriesTemplate configuration object. Within this object, set the data source field that specifies the series name to the nameField option.

If you need to specify individual values for options of a particular series, assign a callback function to the customizeSeries option of the seriesTemplate object.

size

Specifies the widget's size in pixels.

Type:

Default Value: undefined

The widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.

sizeGroup

Allows you to display several adjoining pies in the same size.

Type:

Default Value: undefined

Besides the pie itself, the PieChart widget comprises other diverse elements that affect the size of the pie. Therefore, when you display several PieChart widgets side by side, their pies may differ in size. To eliminate these differences, collect all the PieChart widgets in a single size group by setting their sizeGroup option to identical values. The widgets should have identical layouts, that is, the same container's size, position of the title and legend, etc. Note also that a single page can contain many size groups, but a widget can be a member of only one of them.

startAngle

Specifies the angle in arc degrees from which the first segment of a pie chart should start.

Type:

Default Value: 0

theme

Sets the name of the theme the widget uses.

Type:

Default Value: 'generic.light'

A theme is a widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.

NOTE

The following themes were deprecated or renamed: 'desktop', 'desktop-dark', 'android', 'android-holo-light', *android5.light*, 'ios', 'win8', 'win8-white', 'win8.white', 'win8.black', 'win10.white', 'win10.black'. In new applications, use themes listed in the accepted values.

Use the VizTheme enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, IOS7Default, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

title

Configures the widget's title.

Type:

|

The widget's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title option. Otherwise, set this option to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

tooltip

Configures tooltips.

Type:

A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

type

Specifies the type of the pie chart series.

Type: