jQuery PolarChart API
The PolarChart widget visualizes data in a polar coordinate system. In this system, each point on a plane is determined by the distance from the center (the point's value) and the angle from a fixed direction (the point's argument). To understand how a chart is displayed in a polar coordinate system, imagine how it would be displayed in a rectangular coordinate system and then round off the argument axis in your mind.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the PolarChart widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
var temperature = [
{ month: "January", day: 6, night: 2 },
{ month: "February", day: 7, night: 2 },
{ month: "March", day: 10, night: 3 },
{ month: "April", day: 14, night: 5 },
{ month: "May", day: 18, night: 8 },
{ month: "June", day: 21, night: 11 },
{ month: "July", day: 22, night: 13 },
{ month: "August", day: 22, night: 13 },
{ month: "September", day: 19, night: 11 },
{ month: "October", day: 15, night: 8 },
{ month: "November", day: 10, night: 5 },
{ month: "December", day: 7, night: 3 }
];
$(function() {
$("#polarChart").dxPolarChart({
dataSource: temperature,
commonSeriesSettings: {
argumentField: "month",
type: "scatter"
},
series: [
{ valueField: "day", name: "Day" },
{ valueField: "night", name: "Night" }
]
});
});<div id="polarChart"></div>
Angular
<dx-polar-chart [dataSource]="temperature">
<dxo-common-series-settings
argumentField="month"
type="scatter">
</dxo-common-series-settings>
<dxi-series
valueField="day"
name="Day">
</dxi-series>
<dxi-series
valueField="night"
name="Night">
</dxi-series>
</dx-polar-chart>
import { DxPolarChartModule } from 'devextreme-angular';
// ...
export class AppComponent {
temperature = [
{ month: "January", day: 6, night: 2 },
{ month: "February", day: 7, night: 2 },
{ month: "March", day: 10, night: 3 }
];
}
@NgModule({
imports: [
// ...
DxPolarChartModule
],
// ...
})AngularJS
<div ng-controller="DemoController">
<div dx-polar-chart="{
dataSource: temperature,
commonSeriesSettings: {
argumentField: 'month',
type: 'scatter'
},
series: [
{ valueField: 'day', name: 'Day' },
{ valueField: 'night', name: 'Night' }
]
}"></div>
</div>angular.module('DemoApp', ['dx'])
.controller("DemoController", function ($scope) {
$scope.temperature = [
{ month: "January", day: 6, night: 2 },
{ month: "February", day: 7, night: 2 },
{ month: "March", day: 10, night: 3 }
];
});Knockout
<div data-bind="dxPolarChart: {
dataSource: temperature,
commonSeriesSettings: {
argumentField: 'month',
type: 'scatter'
},
series: [
{ valueField: 'day', name: 'Day' },
{ valueField: 'night', name: 'Night' }
]
}"></div>var viewModel = {
temperature: [
{ month: "January", day: 6, night: 2 },
{ month: "February", day: 7, night: 2 },
{ month: "March", day: 10, night: 3 }
]
};
ko.applyBindings(viewModel);ASP.NET MVC Controls
@(Html.DevExtreme().PolarChart()
.ID("polarChart")
.DataSource(new[] {
new { Month = "January", Day = 6, Night = 2 },
new { Month = "February", Day = 7, Night = 2 },
new { Month = "March", Day = 10, Night = 3 }
})
.CommonSeriesSettings(c => c
.ArgumentField("Month")
.Type(PolarChartSeriesType.Scatter)
)
.Series(series => {
series.Add().ValueField("Day");
series.Add().ValueField("Night");
})
)@(Html.DevExtreme().PolarChart() _
.ID("polarChart") _
.DataSource({
New With { .Month = "January", .Day = 6, .Night = 2 },
New With { .Month = "February", .Day = 7, .Night = 2 },
New With { .Month = "March", .Day = 10, .Night = 3 }
}) _
.CommonSeriesSettings(Sub(c)
c.ArgumentField("Month") _
.Type(PolarChartSeriesType.Scatter)
End Sub) _
.Series(Sub(series)
series.Add().ValueField("Day")
series.Add().ValueField("Night")
End Sub)
)See Also
Configuration
| Name | Description |
|---|---|
| adaptiveLayout |
Specifies adaptive layout options. |
| animation |
Specifies animation options. |
| argumentAxis |
Specifies argument axis options for the PolarChart widget. |
| barWidth |
Specifies a common bar width as a percentage from 0 to 1. |
| commonAxisSettings |
An object defining the configuration options that are common for all axes of the PolarChart widget. |
| commonSeriesSettings |
An object defining the configuration options that are common for all series of the PolarChart widget. |
| containerBackgroundColor |
Specifies the color of the parent page element. |
| customizeLabel |
Customizes the appearance of an individual point label. |
| customizePoint |
Customizes the appearance of an individual series point. |
| dataPrepareSettings |
An object providing options for managing data from a data source. |
| dataSource |
Specifies the widget's data origin. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| equalBarWidth |
Specifies whether or not all bars in a series must have the same angle, or may have different angles if any points in other series are missing. |
| export |
Configures the exporting and printing features. |
| legend |
Specifies the options of a chart's legend. |
| loadingIndicator |
Configures the loading indicator. |
| margin |
Generates space around the widget. |
| negativesAsZeroes |
Forces the widget to treat negative values as zeroes. Applies to stacked-like series only. |
| onArgumentAxisClick |
A handler for the argumentAxisClick event. |
| onDisposing |
A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| onDone |
A function that is executed when all series are ready. |
| onDrawn |
A function that is executed when the widget's rendering has finished. |
| onExported |
A handler for the exported event. Executed after data from the widget is exported. |
| onExporting |
A handler for the exporting event. Executed before data from the widget is exported. |
| onFileSaving |
A handler for the fileSaving event. Executed before a file with exported data is saved on the user's local storage. |
| onIncidentOccurred |
A handler for the incidentOccurred event. Executed when an error or warning appears in the widget. |
| onInitialized |
A handler for the initialized event. Executed only once, after the widget is initialized. |
| onLegendClick |
A handler for the legendClick event. |
| onOptionChanged |
A handler for the optionChanged event. Executed after an option of the widget is changed. |
| onPointClick |
A handler for the pointClick event. |
| onPointHoverChanged |
A handler for the pointHoverChanged event. |
| onPointSelectionChanged |
A handler for the pointSelectionChanged event. |
| onSeriesClick |
A handler for the seriesClick event. |
| onSeriesHoverChanged |
A handler for the seriesHoverChanged event. |
| onSeriesSelectionChanged |
A handler for the seriesSelectionChanged event. |
| onTooltipHidden |
A handler for the tooltipHidden event. |
| onTooltipShown |
A handler for the tooltipShown event. |
| palette |
Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart. |
| pathModified |
Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path. |
| pointSelectionMode |
Specifies whether a single point or multiple points can be selected in the chart. |
| redrawOnResize |
Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates. |
| resolveLabelOverlapping |
Specifies how the chart must behave when series point labels overlap. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| series |
Specifies options for PolarChart widget series. |
| seriesSelectionMode |
Specifies whether a single series or multiple series can be selected in the chart. |
| seriesTemplate |
Defines options for the series template. |
| size |
Specifies the widget's size in pixels. |
| theme |
Sets the name of the theme the widget uses. |
| title |
Configures the widget's title. |
| tooltip |
Configures tooltips. |
| useSpiderWeb |
Indicates whether or not to display a "spider web". |
| valueAxis |
Specifies value axis options for the PolarChart widget. |
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| clearSelection() |
Deselects the chart's selected series. The series is displayed in an initial style. |
| dispose() |
Disposes of all the resources allocated to the PolarChart instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| exportTo(fileName, format) |
Exports the widget. |
| getAllSeries() |
Gets all the series. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| getSeriesByName(seriesName) |
Gets a series with a specific name. |
| getSeriesByPos(seriesIndex) |
Gets a series with a specific index. |
| getSize() |
Gets the current widget size. |
| hideLoadingIndicator() |
Hides the loading indicator. |
| hideTooltip() |
Hides all widget tooltips. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| print() |
Opens the browser's print window. |
| render() |
Redraws the widget. |
| render(renderOptions) |
Redraws the widget. |
| showLoadingIndicator() |
Shows the loading indicator. |
| svg() |
Gets the widget's SVG markup. |
Events
| Name | Description |
|---|---|
| argumentAxisClick |
Fires when a user clicks a label on the argument axis. |
| disposing |
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. |
| done |
Raised when all series are ready. |
| drawn |
Raised when the widget's rendering has finished. |
| exported |
Raised after data from the widget is exported. |
| exporting |
Raised before data from the widget is exported. |
| fileSaving |
Raised before a file with exported data is saved on the user's local storage. |
| incidentOccurred |
Raised when an error or warning appears in the widget. |
| initialized |
Raised only once, after the widget is initialized. |
| legendClick |
Fires when an item on the chart legend is clicked. |
| optionChanged |
Raised after a widget option is changed. |
| pointClick |
Fires when a user clicks a series point. |
| pointHoverChanged |
Fires when the hover state of a series point has been changed. |
| pointSelectionChanged |
Fires when the selection state of a series point has been changed. |
| seriesClick |
Fires when a user clicks a series. |
| seriesHoverChanged |
Fires when the hover state of a series has been changed. |
| seriesSelectionChanged |
Fires when the selection state of a series has been changed. |
| tooltipHidden |
Fires when a point's tooltip becomes hidden. |
| tooltipShown |
Fires when a point's tooltip appears. |
Series Types
| Name | Description |
|---|---|
| AreaSeries |
An object defining a series of the area type. |
| BarSeries |
An object defining a series of the bar type. |
| LineSeries |
An object defining a series of the line type. |
| ScatterSeries |
An object defining a series of the scatter type. |
| StackedBarSeries |
An object defining a series of the stackedBar type. |