An object that defines configuration properties for the PieChart UI component.
Specifies adaptive layout properties.
Selector: DxAdaptiveLayout
The adaptive layout enables the UI component to hide optional elements if they do not fit in the container. Elements are hidden in the following sequence:
Use the height and width properties in the adaptiveLayout object to specify the minimum container size at which the layout begins to adapt.
See AlsoSpecifies animation properties.
The UI component animates its elements at the beginning of its lifetime and when the data source changes.
If multiple charts on the page do not fit in the window, the animation may not work smoothly.
Disablethe animation or adjust the markup to fit the charts.
jQuery$(function() { $("#pieChartContainer").dxPieChart({ // ... animation: { easing: "linear", duration: 500, maxPointCountSupported: 100 } }); });Angular
<dx-pie-chart ... > <dxo-animation easing="linear" [duration]="500" [maxPointCountSupported]="100"> </dxo-animation> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... > <DxAnimation easing="linear" :duration="500" :max-point-count-supported="100" /> </DxPieChart> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPieChart, { DxAnimation } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart, DxAnimation }, // ... } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import PieChart, { Animation } from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... > <Animation easing="linear" duration={500} maxPointCountSupported={100} /> </PieChart> ); } } export default App;
Specifies the annotation collection.
Annotations are containers for images, text blocks, and custom content that display additional information about the visualized data.
To create annotations, assign an array of objects to the annotations[] property. Each object configures an individual annotation. You can set each annotation's type property to "text", "image", or "custom". Depending on the type, specify the annotation's text, image, or template property:
jQuery$(function() { $("#pieChart").dxPieChart({ annotations: [{ type: "text", text: "Annotation text" }, { type: "image", image: "http://image/url/myimage.png" }, { type: "custom", template: function(annotation) { const data = annotation.data; const $svg = $("<svg>"); // ... // Customize the annotation's markup here // ... return $svg; } }] }); });Angular
<dx-pie-chart ... > <dxi-annotation type="text" text="Annotation text"> </dxi-annotation> <dxi-annotation type="image" image="http://image/url/myimage.png"> </dxi-annotation> <dxi-annotation type="custom" template="custom-annotation"> </dxi-annotation> <svg *dxTemplate="let annotation of 'custom-annotation'"> <!-- Declare custom SVG markup here --> </svg> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... > <DxAnnotation type="text" text="Annotation text" /> <DxAnnotation type="image" image="http://image/url/myimage.png" /> <DxAnnotation type="custom" template="custom-annotation" /> <template #custom-annotation="{ data }"> <svg> <!-- Declare custom SVG markup here --> </svg> </template> </DxPieChart> </template> <script> import DxPieChart, { DxAnnotation } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart, DxAnnotation }, data() { // ... } } </script>React
import React from 'react'; import PieChart, { Annotation } from 'devextreme-react/pie-chart'; function CustomAnnotation(annotation) { const data = annotation.data; return ( <svg> {/* Declare custom SVG markup here */} </svg> ); } export default function App() { return ( <PieChart ... > <Annotation type="text" text="Annotation text" /> <Annotation type="image" image="http://image/url/myimage.png" /> <Annotation type="custom" render={CustomAnnotation} /> </PieChart> ); }
Annotations can be unattached or anchored to a chart element. The following list shows how to position them. Chart coordinates (argument and series) specify the element that the annotation's arrow points to; pixel coordinates (x and y) specify the position of the annotation's center.
Unanchored annotation
annotations: [{ x: 100, y: 200 }]
Annotation anchored to a series point
annotations: [{ argument: "California", series: "States" // required if the PieChart contains more than one series }]
Annotation positioned at an argument's edge
annotations: [{ argument: "Alaska", series: "States", location: "edge" }]
The PieChart displays a tooltip when a user long-presses an annotation or hovers the mouse pointer over it.
Objects in the annotations[] array configure individual annotations. To specify properties that apply to all annotations, use the commonAnnotationSettings object. Individual settings take precedence over common settings.
See AlsoSpecifies a custom template for content in the pie's center.
Selector: center-template
Function parameters:The UI component's instance.
An empty SVGGElement that acts as a container for the template content.
One of the following:
Default Value: undefined
You need to render template content as an SVG element. The following code snippet shows how to specify a custom template for content in the PieChart's center:
jQuery$(function(){ $("#pieChartContainer").dxPieChart({ // ... type: "doughnut", centerTemplate: (pie, container) => { const circle = createCircle("green", "yellow"); const text = createText(20, 80, 12, 'start', "Doughnut PieChart"); container.appendChild(circle); container.appendChild(text); }, }); }); function createCircle(stroke, fill) { const circle = document.createElementNS('http://www.w3.org/2000/svg', 'circle'); circle.setAttribute('cx', 72); circle.setAttribute('cy', 80); circle.setAttribute('r', 70); circle.setAttribute('stroke-width', 4); circle.setAttribute('stroke', stroke); circle.setAttribute('fill', fill); return circle; } function createText(x, y, fontSize, textAnchor, content) { const text = document.createElementNS('http://www.w3.org/2000/svg', 'text'); text.setAttribute('x', x); text.setAttribute('y', y); text.setAttribute('fill', '#000'); text.setAttribute('text-anchor', textAnchor); text.setAttribute('font-size', fontSize); text.textContent = content; return text; }Angular
<dx-pie-chart type="doughnut" centerTemplate="centerTemplate" ... > <svg *dxTemplate="let pie of 'centerTemplate'"> <circle cx="72" cy="80" r="70" stroke="green" stroke-width="4" fill="yellow" /> <text text-anchor="start" y="80" x="20" fill="#000" font-size="12"> Doughnut PieChart </text> </svg> </dx-pie-chart>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
App.vue (Composition API)
<template> <DxPieChart type="doughnut" center-template="centerTemplate" ... > <template #centerTemplate="data"> <svg> <circle cx="72" cy="80" r="70" stroke="green" stroke-width="4" fill="yellow" /> <text text-anchor="start" y="80" x="20" fill="#000" font-size="12"> Doughnut PieChart </text> </svg> </template> > </DxPieChart> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, data() { return { // ... } } } </script>
<template> <DxPieChart type="doughnut" center-template="centerTemplate" ... > <template #centerTemplate="data"> <svg> <circle cx="72" cy="80" r="70" stroke="green" stroke-width="4" fill="yellow" /> <text text-anchor="start" y="80" x="20" fill="#000" font-size="12"> Doughnut PieChart </text> </svg> </template> > </DxPieChart> </template> <script setup> import DxPieChart from 'devextreme-vue/pie-chart'; const data = { ... }; // ... </script>React
import PieChart from 'devextreme-react/pie-chart'; const CenterTemplate = (pie) => { return ( <svg> <circle cx="72" cy="80" r="70" stroke="green" stroke-width="4" fill="yellow" /> <text text-anchor="start" y="80" x="20" fill="#000" font-size="12"> Doughnut Pie Chart </text> </svg> ); } export default function App() { return ( <PieChart type="doughnut" centerRender={CenterTemplate} ... > { /* ... */ } </PieChart> ); }
Specifies settings common for all annotations in the PieChart.
Selector: DxCommonAnnotationSettings
Settings specified here can be ignored in favor of individual annotation settings specified in the annotations[] array. Refer to the array's description for information on how to configure annotations.
The following code shows the commonAnnotationSettings declaration syntax:
jQuery$(function() { $("#pieChart").dxPieChart({ // ... commonAnnotationSettings: { tooltipEnabled: false } }); });Angular
<dx-pie-chart ... > <dx-common-annotation-settings [tooltipEnabled]="false"> </dx-common-annotation-settings> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... > <DxCommonAnnotationSettings :tooltip-enabled="false" /> </DxPieChart> </template> <script> import DxPieChart, { DxCommonAnnotationSettings } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart, DxCommonAnnotationSettings }, data() { // ... } } </script>React
import React from 'react'; import PieChart, { CommonAnnotationSettings } from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... > <CommonAnnotationSettings tooltipEnabled={false} /> </PieChart> ); } } export default App;See Also
An object defining the configuration properties that are common for all series of the PieChart UI component.
Selector: DxCommonSeriesSettings
Type: any
Use this object's properties to set properties for all chart series at once.
Customizes an individual annotation.
Selector: customize-annotation
Function parameters:The annotation before customizations.
The annotation after customizations.
Default Value: undefined
Cannot be used in themes.
The following code shows how to use the customizeAnnotation function to apply different settings to text and image annotations:
jQuery$(function() { $("#pieChartContainer").dxPieChart({ // ... customizeAnnotation: function(annotationItem) { if(annotationItem.text) { annotationItem.color = "red"; } if(annotationItem.image) { annotationItem.color = "blue"; } return annotationItem; } }); });Angular
<dx-pie-chart ... [customizeAnnotation]="customizeAnnotation"> </dx-pie-chart>
// ... export class AppComponent { customizeAnnotation(annotationItem) { if(annotationItem.text) { annotationItem.color = "red"; } if(annotationItem.image) { annotationItem.color = "blue"; } return annotationItem; } }
import { DxPieChartModule } from 'devextreme-angular'; // ... @NgModule({ imports: [ // ... DxPieChartModule ], // ... }) export class AppModule { }Vue
<template> <DxPieChart ... :customize-annotation="customizeAnnotation"> </DxPieChart> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, methods: { customizeAnnotation(annotationItem) { if(annotationItem.text) { annotationItem.color = "red"; } if(annotationItem.image) { annotationItem.color = "blue"; } return annotationItem; } } } </script>React
import React from 'react'; import PieChart from 'devextreme-react/pie-chart'; export default function App() { const customizeAnnotation = (annotationItem) => { if(annotationItem.text) { annotationItem.color = "red"; } if(annotationItem.image) { annotationItem.color = "blue"; } return annotationItem; } return ( <PieChart ... customizeAnnotation={customizeAnnotation}> </PieChart> ); }ASP.NET MVC Controls
@(Html.DevExtreme().PieChart() @* ... *@ .CustomizeAnnotation("customizeAnnotation") ) <script type="text/javascript"> function customizeAnnotation(annotationItem) { if(annotationItem.text) { annotationItem.color = "red"; } if(annotationItem.image) { annotationItem.color = "blue"; } return annotationItem; } </script>See Also
Customizes the appearance of an individual point label.
Selector: customize-label
Function parameters:Information on the series point.
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 properties that will be changed for a certain label. See the label object for information about all properties 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. data An object that contains the series point data.Customizes the appearance of an individual series point.
Selector: customize-point
Function parameters:Information on the series point.
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 properties that should be changed for a certain point. The following pie properties can be changed.
When implementing a callback function for this property, use the argument or value of a point. They can be accessed using the following fields of the function's parameter.
Field Description argument The argument of the series point. value The value of the series point. tag The tag of the series point. index The index of the series point in the points array. data An object that contains the series point data.In addition, these values can be accessed using the this object.
Binds the UI component to data.
Selector: data-source
Cannot be used in themes.
The PieChart works with collections of objects.
Depending on your data source, bind PieChart to data as follows.
Data Array
Assign the array to the dataSource option. View Demo
Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data. View Demo
OData
Implement an ODataStore.
Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:
Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery$(function() { let serviceUrl = "https://url/to/my/service"; $("#pieChartContainer").dxPieChart({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });Angular
import { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-pie-chart ... [dataSource]="store"> </dx-pie-chart>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxPieChart } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import PieChart from 'devextreme-react/pie-chart'; const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); class App extends React.Component { render() { return ( <PieChart ... dataSource={store} /> ); } } export default App;
Any other data source
Implement a CustomStore.
Regardless of the data source on the input, the PieChart always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.
After providing data, bind series to it.
Review the following notes about data binding:
If you wrap the store into the DataSource object explicitly, set the paginate property to false to prevent data from partitioning.
Field names cannot be equal to this
and should not contain the following characters: .
, :
, [
, and ]
.
PieChart does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.
Specifies the diameter of the pie.
This property accepts a number that identifies the ratio between the pie's diameter and the UI component's width or height (depending on which of them is less). For example, assume that the UI component's size is 300x500 pixels and the diameter property is set to 0.5. Then, the resulting diameter of the pie will be:
0.5 * min(300,500) = 0.5 * 300 = 150 pixels
See AlsoSpecifies whether the UI component responds to user interaction.
Default Value: false
Cannot be used in themes.
Specifies the global attributes to be attached to the UI component's container element.
Selector: DxElementAttr
Default Value: {}
jQuery$(function(){ $("#pieChartContainer").dxPieChart({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });Angular
<dx-pie-chart ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-pie-chart>
import { DxPieChartModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxPieChartModule ], // ... })Vue
<template> <DxPieChart ... :element-attr="pieChartAttributes"> </DxPieChart> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, data() { return { pieChartAttributes: { id: 'elementId', class: 'class-name' } } } } </script>React
import React from 'react'; import PieChart from 'devextreme-react/pie-chart'; class App extends React.Component { pieChartAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <PieChart ... elementAttr={this.pieChartAttributes}> </PieChart> ); } } export default App;
Configures the exporting and printing features.
Selector: DxExport
Type: viz/core/base_widget:BaseWidgetExport
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.
Selector: inner-radius
Default Value: 0.5
This member is exposed by the following entities:
Use this property to change the amount of space occupied by the inner area of the doughnut-type pie chart.
Specifies PieChart legend properties.
The PieChart UI component 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 properties to the required values. To learn more about the legend and its properties, refer to the Legend topic.
Configures the loading indicator.
Selector: DxLoadingIndicator
Type: viz/core/base_widget:BaseWidgetLoadingIndicator
When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.
To enable the automatic loading indicator, set the enabled property to true.
If you want to change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.
Generates space around the UI component.
Selector: DxMargin
Type: viz/core/base_widget:BaseWidgetMargin
jQuery$(function() { $("#pieChartContainer").dxPieChart({ // ... margin: { top: 20, bottom: 20, left: 30, right: 30 } }); });Angular
<dx-pie-chart ... > <dxo-margin [top]="20" [bottom]="20" [left]="30" [right]="30"> </dxo-margin> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... > <DxMargin :top="20" :bottom="20" :left="30" :right="30" /> </DxPieChart> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPieChart, { DxMargin } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart, DxMargin }, // ... } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import PieChart, { Margin } from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... > <Margin top={20} bottom={20} left={30} right={30} /> </PieChart> ); } } export default App;
Specifies the minimum diameter of the pie.
Selector: min-diameter
Default Value: 0.5
This property specifies the minimum ratio between the pie's diameter and the UI component's width or height (depending on which of them is less). For example, assume that the UI component's size is 300x500 pixels and the minDiameter property is 0.7. Then, the diameter of the pie will never be less than:
0.7 * min(300,500) = 0.7 * 300 = 210 pixels
This property is ignored if the
diameterproperty is set.
See AlsoA function that is executed before the UI component is disposed of.
Selector: @disposing
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when all series are ready.
Selector: @done
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed when the UI component's rendering has finished.
Selector: @drawn
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed after the UI component is exported.
Selector: @exported
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is exported.
Selector: @exporting
Function parameters:Information about the event.
Object structure:
Name Type Description formatThe resulting file format. One of PNG, PDF, JPEG, SVG and GIF.
fileNameThe name of the file to which the UI component is about to be exported.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
A function that is executed before a file with exported UI component is saved to the user's local storage.
Selector: @file-saving
Function parameters:Information about the event.
Object structure:
Name Type Description formatThe format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
The name of the file to be saved.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
dataExported data as a BLOB.
componentThe UI component's instance.
cancelAllows you to prevent file saving.
Default Value: null
A function that is executed when an error or warning occurs.
Selector: @incident-occurred
Function parameters:Information about the event.
Object structure:
Default Value: null
The UI component 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:
A function used in JavaScript frameworks to save the UI component instance.
Selector: @initialized
Function parameters:Information about the event.
Object structure:
Default Value: null
Angular<dx-pie-chart ... (onInitialized)="saveInstance($event)"> </dx-pie-chart>
import { Component } from "@angular/core"; import PieChart from "devextreme/ui/data_grid"; // ... export class AppComponent { pieChartInstance: PieChart; saveInstance (e) { this.pieChartInstance = e.component; } }Vue
App.vue (Composition API)
<template> <div> <DxPieChart ... @initialized="saveInstance"> </DxPieChart> </div> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, data: function() { return { pieChartInstance: null }; }, methods: { saveInstance: function(e) { this.pieChartInstance = e.component; } } }; </script>
<template> <div> <DxPieChart ... @initialized="saveInstance"> </DxPieChart> </div> </template> <script setup> import DxPieChart from 'devextreme-vue/pie-chart'; let pieChartInstance = null; const saveInstance = (e) => { pieChartInstance = e.component; } </script>React
import PieChart from 'devextreme-react/pie-chart'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.pieChartInstance = e.component; } render() { return ( <div> <PieChart onInitialized={this.saveInstance} /> </div> ); } }See Also jQuery
A function that is executed when a legend item is clicked or tapped.
Selector: @legend-click
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed after a UI component property is changed.
Selector: @option-changed
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
The following example shows how to subscribe to component property changes:
jQuery$(function() { $("#pieChartContainer").dxPieChart({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });Angular
<dx-pie-chart ... (onOptionChanged)="handlePropertyChange($event)"> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import PieChart from 'devextreme-react/pie-chart'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <PieChart ... onOptionChanged={handlePropertyChange} /> ); }
A function that is executed when a series point is clicked or tapped.
Selector: @point-click
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
The onSeriesClick function is executed after this function. The following code shows how to prevent this:
jQuery$(function () { $("#pieChartContainer").dxPieChart({ // ... onPointClick: function (e) { e.cancel = true; } }); });Angular
import { DxPieChartModule } from "devextreme-angular"; // ... export class AppComponent { cancelSeriesClick (e) { e.cancel = true; } } @NgModule({ imports: [ // ... DxPieChartModule ], // ... })
<dx-pie-chart ... (onPointClick)="cancelSeriesClick($event)"> </dx-pie-chart>Vue
<template> <DxPieChart ... @point-click="cancelSeriesClick"> </DxPieChart> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, methods: { cancelSeriesClick (e) { e.cancel = true; } } } </script>React
import React from 'react'; import PieChart from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... onPointClick={this.cancelSeriesClick}> </PieChart> ); } cancelSeriesClick (e) { e.cancel = true; } } export default App;
A function that is executed after the pointer enters or leaves a series point.
Selector: @point-hover-changed
Function parameters:Information about the event.
Object structure:
Name Type Description targetThe series point whose hover state has been changed; described in the Point section.
elementThe UI component's container.
componentThe UI component's instance.
Cannot be used in themes.
If a PieChart contains only one series, onPointHoverChanged is also called after the pointer enters or leaves legend elements. To identify whether the pointer has entered or left a series point/legend element, call the Point.isHovered() method.
A function that is executed when a series point is selected or selection is canceled.
Selector: @point-selection-changed
Function parameters:Information about the event.
Object structure:
Name Type Description targetThe series point whose selection state has been changed; described in the Point section.
elementThe UI component's container.
componentThe UI component's instance.
Cannot be used in themes.
To identify whether the selection has been applied or canceled, call the point's isSelected() method.
A function that is executed when a tooltip becomes hidden.
Selector: @tooltip-hidden
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed when a tooltip appears.
Selector: @tooltip-shown
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
Sets the palette to be used to colorize series and their elements.
Default Value: 'Material'
Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart UI component) or points in a series (in the PieChart UI component).
Selector: palette-extension-mode
Default Value: 'blend'
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.
Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.
Selector: path-modified
Default Value: false
Cannot be used in themes.
If you place the UI component on a page that uses a tag modifying the path (<base>
, <iframe>
, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.
Specifies whether a single point or multiple points can be selected in the chart.
Selector: point-selection-mode
Default Value: 'single'
To set the points to highlight along with the selected point, set the series.selectionMode property.
Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.
Selector: redraw-on-resize
Default Value: true
Cannot be used in themes.
When this property is set to true
, the UI component will be redrawn automatically in case the size of its container changes.
Specifies how a chart must behave when point labels overlap.
Selector: resolve-label-overlapping
Default Value: 'none'
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 property. To hide certain labels, set this property to 'hide'. Labels to be hidden will be determined automatically. To resolve overlapping by shifting labels from their positions, set the resolveLabelOverlapping property 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.
If the
positionproperty is set to
"inside", the
"shift"mode in label overlapping is not available.
Switches the UI component to a right-to-left representation.
Selector: rtl-enabled
Default Value: false
Cannot be used in themes.
When this property is set to true, the UI component 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.
DevExpress.config({ rtlEnabled: true });
In a right-to-left representation, SVG elements have the
directionattribute with the
rtlvalue. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.
Specifies the direction that the pie chart segments will occupy.
Selector: segments-direction
Default Value: 'clockwise'
Specifies properties for the series of the PieChart UI component.
Selector: DxSeries
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 property. If PieChart must contain several series, assign an array of such objects to the same property. 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 UI component 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.
Defines properties for the series template.
Selector: DxSeriesTemplate
Default Value: undefined
Cannot be used in themes.
In most cases, you can organize the array that is assigned to the chart's dataSource property 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 property.
If you need to specify individual values for properties of a particular series, assign a callback function to the customizeSeries property of the seriesTemplate object.
Specifies the UI component's size in pixels.
Selector: DxSize
Type: viz/core/base_widget:BaseWidgetSize
Default Value: {height: 400, width: 400}
You can specify a custom width and height for the component:
Fixed Relative Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.The size object has priority over the container.
Assign 0 to the size object's height and width properties to hide the component.
jQuery$(function() { $("#pieChartContainer").dxPieChart({ // ... size: { height: 300, width: 600 } }); });Angular
<dx-pie-chart ... > <dxo-size [height]="300" [width]="600"> </dxo-size> </dx-pie-chart>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPieChartModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPieChartModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxPieChart ... > <DxSize :height="300" :width="600" /> </DxPieChart> </template> <script> import DxPieChart, { DxSize } from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart, DxSize }, // ... } </script>React
import React from 'react'; import PieChart, { Size } from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... > <Size height={300} width={600} /> </PieChart> ); } } export default App;
Alternatively, you can use CSS to style the UI component's container:
jQuery$(function() { $("#pieChart").dxPieChart({ // ... }); });
#pieChart { width: 85%; height: 70%; }Angular
<dx-pie-chart ... id="pieChart"> </dx-pie-chart>
#pieChart { width: 85%; height: 70%; }Vue
<template> <DxPieChart ... id="pieChart"> </DxPieChart> </template> <script> import DxPieChart from 'devextreme-vue/pie-chart'; export default { components: { DxPieChart }, // ... } </script> <style> #pieChart { width: 85%; height: 70%; } </style>React
import React from 'react'; import PieChart from 'devextreme-react/pie-chart'; class App extends React.Component { render() { return ( <PieChart ... id="pieChart"> </PieChart> ); } } export default App;
#pieChart { width: 85%; height: 70%; }
Allows you to display several adjoining pies in the same size.
Selector: size-group
Default Value: undefined
Besides the pie itself, the PieChart UI component comprises other diverse elements that affect the size of the pie. Therefore, when you display several PieChart UI components side by side, their pies may differ in size. To eliminate these differences, collect all the PieChart UI components in a single size group by setting their sizeGroup property to identical values. The UI components 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 UI component can be a member of only one of them.
See AlsoSpecifies the angle in arc degrees from which the first segment of a pie chart should start.
Selector: start-angle
Default Value: 0
Sets the name of the theme the UI component uses.
Default Value: 'generic.light'
A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.
Configures the UI component's title.
Selector: DxTitle
Type: viz/core/base_widget:BaseWidgetTitle
The UI component'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 property. Otherwise, set this property 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.
Configures tooltips.
Selector: DxTooltip
Type: viz/chart_components/base_chart:BaseChartTooltip
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.
Specifies the type of the pie chart series.
See Series Overview for details.
Feel free to share topic-related thoughts here.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4