PolarChart

The PolarChart is a widget that visualizes data in a polar coordinate system.

Included in: dx.viz.js, dx.viz-web.js, dx.all.js
Module: viz/polar_chart
Export: default
PolarChart interactive configuration
Copy Code
Copy to Codepen
$("#polarchart").dxPolarChart({
});

                    

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 HTML5 Charts DataVisualization DevExtreme HTML5 Charts PolarChart RadarChart DataVisualization

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    JavaScript
    <div id="polarChart"></div>
    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" }
            ]
        });
    });
  • Angular

    HTML
    JavaScript
    <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>
    export class AppComponent {
        temperature = [
            // ...   
        ];
    }
  • AngularJS

    HTML
    JavaScript
    <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 = [
                // ...   
            ];
        });
  • Knockout

    HTML
    JavaScript
    <div data-bind="dxPolarChart: {
        dataSource: temperature,
        commonSeriesSettings: {     
            argumentField: 'month',
            type: 'scatter'
        },
        series: [
            { valueField: 'day', name: 'Day' }, 
            { valueField: 'night', name: 'Night' }
        ]
    }"></div>
    var viewModel = {
        temperature: [
            // ...
        ]
    };
    ko.applyBindings(viewModel);
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().PolarChart()
        .ID("polarChart")
        .DataSource(Temperature)
        .CommonSeriesSettings(c => c
            .ArgumentField("month")
            .Type(PolarChartSeriesType.Scatter)
        )
        .Series(series => {
            series.Add().ValueField("day");
            series.Add().ValueField("night");
        })
    )
    @(Html.DevExtreme().PolarChart() _
        .ID("polarChart") _
        .DataSource(Temperature) _
        .CommonSeriesSettings(Sub(c)
            c.ArgumentField("month") _
             .Type(PolarChartSeriesType.Scatter)
        End Sub) _
        .Series(Sub(series)
            series.Add().ValueField("day")
            series.Add().ValueField("night")
        End Sub)
    )

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo Watch Video

See Also

Configuration

An object defining configuration options for the PolarChart widget.

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

Specifies a callback function that returns an object with options for a specific point label.

customizePoint

Specifies a callback function that returns an object with options for a specific point.

dataPrepareSettings

An object providing options for managing data from a data source.

dataSource

Specifies the origin of data for the widget.

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.

onDone

A handler for the done event.

onDrawn

A handler for the drawn event.

onExported

A handler for the exported event.

onExporting

A handler for the exporting event.

onFileSaving

A handler for the fileSaving event.

onIncidentOccurred

A handler for the incidentOccurred event.

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.

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

Specifies whether or not the widget supports 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 size of the widget in pixels.

theme

Sets the name of the theme to be used in the widget.

title

Specifies the widget title.

tooltip

Configures tooltips.

useSpiderWeb

Indicates whether or not to display a "spider web".

valueAxis

Specifies value axis options for the PolarChart widget.

Methods

This section describes the methods that can be used in code to manipulate the PolarChart widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

clearSelection()

Deselects the chart's selected series. The series is displayed in an initial style.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

getAllSeries()

Returns an array of all series in the chart.

getDataSource()

Returns the DataSource instance.

getSeriesByName(seriesName)

Gets a series within the chart's series collection by the specified name (see the name option).

getSeriesByPos(seriesIndex)

Gets a series within the chart's series collection by its position number.

getSize()

Gets the current size of the widget.

hideLoadingIndicator()

Conceals the loading indicator.

hideTooltip()

Hides all widget tooltips.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

print()

Opens the browser's print window.

render()

Redraws the widget.

render(renderOptions)

Redraws a widget.

showLoadingIndicator()

Displays the loading indicator.

svg()

Returns the widget's SVG markup.

Use the dxPolarChart registered method to access the PolarChart widget as demonstrated in the code below.

JavaScript
var chart = $("#chartContainer").dxPolarChart("instance");

Events

This section describes events fired by this widget.

Name Description
argumentAxisClick

Fires when a user clicks a label on the argument axis.

disposing

Fires when the widget is being removed.

done

Fires when the Series and Point chart elements are ready to be accessed.

drawn

Fires when the widget has finished drawing itself.

exported

Fires after data from the widget is exported.

exporting

Fires before data from the widget is exported.

fileSaving

Fires before a file with exported data is saved on the user's local storage.

incidentOccurred

Fires when an error or warning appears in a widget.

initialized

Raised only once, after the widget is initialized.

legendClick

Fires when an item on the chart legend is clicked.

optionChanged

Fires after an option of the component 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

This section lists objects that define options used to configure series of specific types.

Chart Elements

This section lists the methods and fields of chart elements.