Configuration

An object defining configuration options for the PolarChart widget.

adaptiveLayout

Specifies adaptive layout options.

Type: Object

When adapting to the small screen or container size, the widget may hide its accessory elements, thus saving space for more valuable ones. The elements are being hidden in the following sequence.

  1. Title
  2. Export menu icon
  3. Legend
  4. Argument axis labels
  5. Point labels (can be saved by setting the adaptiveLayout | keepLabels option to true)

To specify the widget's size small enough for the layout to begin adapting, use the height and width options of the adaptiveLayout object.

View Demo on JSFiddle

animation

Specifies animation options.

Type: Object|Boolean

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

argumentAxis

Specifies argument axis options for the PolarChart widget.

Type: Object

For charting, the polar coordinate system is used to determine each point uniquely on a plane through two numbers, the argument and the value of the point. A circular and straight lines (the axis of arguments and the axis of values) are specified to define the coordinates. To define the argument axis, use the argumentAxis configuration object. To define the value axis, use the valueAxis configuration object. To set the properties of all axes to a common value, use the commonAxisSettings configuration object. This object exposes the properties that can be specified for all axes simultaneously. Note that the value specified for an axis individually (in the argumentAxis or valueAxis object) overrides the value specified in the commonAxisSettings object.

Show Example:
jQuery

This example shows the argument axis of a continuous type. Here, the axis' start angle is 90 degrees and labels are customized to indicate degrees as the unit of the axis' values. In addition, the minor grid lines of the axis are made invisible and major grid lines are drawn with an interval equal to 10.


                                    

                                    

barWidth

Specifies a common bar width as a percentage from 0 to 1.

Type: Number
Default Value: undefined

Works only if the equalBarWidth option is set to true.

commonAxisSettings

An object defining the configuration options that are common for all axes of the PolarChart widget.

Type: Object

Use this object's properties to set the options for all chart axes at once. The option values will be applied to the argument axis and all values axes, which are defined in the valueAxis array. To set a common axis option for an axis individually, use the corresponding valueAxis or argumentAxis object. Values that are set individually override their corresponding common values.

Show Example:
jQuery

Here, the color and width options are changed for both axes.


                                    

                                    

commonSeriesSettings

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

Type: Object

Use this object's properties to set options for all chart series at once. These can be options common to all series types and options specific to series types.

If you have several series of one type, you can set options to the values specific to this series type using the corresponding object (area, line or another) within the commonSeriesSettings configuration object. The values that are set within type-specific configuration objects override the corresponding common values.

In case you have to set an option for an individual series, use the corresponding series object within the series array. The values that are set individually override the corresponding common values.

Show Example:
jQuery

In this example, the chart type and the argument field options are set for all series at once using the commonSeriesSettings option.


                                    

                                    

containerBackgroundColor

Specifies the color of the parent page element.

Type: String
Default Value: '#FFFFFF'

If you set this property to the color of the parent page element, certain chart elements will use this color to coordinate with the page. For example, hovered points in the PolarChart widget are painted in the color that is set to this property, but you can change this color to a custom color (see color).

Show Example:
jQuery

Here, the containerBackgroundColor option is changed to 'aqua'. To see the changes, hover over any point on the chart.


                                    

                                    

customizeLabel

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

Type: function(labelInfo)
Function parameters:
labelInfo: Object
Information on the label to be customized
Return Value: Label
A configuration object for the label

By default, all point labels on a chart are displayed identically. But you can specify different appearance for specific labels using the customizeLabel field. Assign a function to this field. This function should return an object with options that should be changed for a certain label. Refer to the label object description to learn about the options that can be changed.

When implementing a callback function for this option, you can access the following fields of the function's parameter.

  • seriesName
    The name of the current series.
  • argument
    The argument of the label's point.
  • value
    The value of the label's point.
  • tag
    The tag of the label's point.
  • index
    The index of the label's point in the points array.

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

Show Example:
jQuery

This example shows how to customize point labels using the customizeLabel option. On this chart, if the argument of a point is greater than 20, the label of this point is colored in 'darkorange'.


                                    

                                    

customizePoint

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

Type: function(pointInfo)
Function parameters:
pointInfo: Object
Information on the point to be customized
Return Value: Point configuration
A configuration object for the point

By default, all points on a chart 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 must be changed for a specific point. Refer to the point object description to learn about the options that can be changed.

NOTE
The hoverMode and selectionMode options cannot be changed using the customizePoint option.

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.
  • seriesName
    The name of the series to which the point belongs.
  • index
    The index of the point in the points array.

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

Show Example:
jQuery

This example shows how to customize series points using the customizePoint option. On this chart, if the argument of a point is greater than 20, this point is colored in 'darkorange', otherwise — 'royalblue'.


                                    

                                    

dataPrepareSettings

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

Type: Object

When values from a data source are of a different type, they may be displayed incorrectly on a chart. To resolve this situation, use the options provided by the dataPrepareSettings configuration object. You can enable/disable data validation using the checkTypeForAllData option, or specify whether or not to convert the data source values to the type of the axis using the convertToAxisDataType option. In addition, you can sort the series points using the sortingMethod option.

Show Example:
jQuery

In this example, the data source has values of different types. These value types are checked and converted into the axis type as the checkTypeForAllData and convertToAxisDataType options are set to true. In addition, the series points are sorted in descending order by values using the function assigned to the sortingMethod option.


                                    

                                    

dataSource

Specifies the origin of data for the widget.

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.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE
When using the DataSource object, turn the pagination off to prevent data from partitioning.
See Also
Show Example:
jQuery

In this example, the data source is declared as an array of objects that each contain the 'arg', 'y1', 'y2' and 'y3' fields. The 'arg' field is used as an argument field for all series. The other fields are used as value fields for each series respectively.


                                    

                                    

elementAttr

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

Type: Object
Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

Razor C#
Razor VB
@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" },
        // ...
    })
)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

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.

Type: Boolean
Default Value: true

If some values for a series are set to zero or not specified, bars that represent these values will be missing from the chart. To fill the empty area by extending the angle of the neighboring bars, set the equalBarWidth property to false. The bars will have different angles, but there will be no empty areas.

To set a custom angle for bars, as well as the spacing between bars, use the barWidth option.

If the widget's container is not large enough to contain bars of the specified width along with the specified spacing between them, the spacing will be ignored.

Show Example:
jQuery

In the example below, use the check box to enable/disable equal bar width.


                                    

                                    

export

Configures the exporting and printing features.

Type: Object

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
IE9 and Safari on Mac OS do 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.
See Also

Watch Video

legend

Specifies the options of a chart's legend.

Type: Object

The PolarChart widget can include a legend - an explanatory component that helps you identify a series. Each series is represented by an item on a Legend. An item marker identifies the series color. An item label displays the series title. To set the required position for a legend and its items, to customize the font settings for item labels, and to specify the size of item markers, use the properties of the legend configuration object. To learn more on the legend and its options, refer to the Legend topic.

Show Example:
jQuery

In this example, the legend is bordered.


                                    

                                    

loadingIndicator

Configures the loading indicator.

Type: Object

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.

See Also

margin

Generates space around the widget.

Type: Object

WidgetMargin DevExtreme ChartJS

negativesAsZeroes

Forces the widget to treat negative values as zeroes. Applies to stacked-like series only.

Type: Boolean
Default Value: false

Oftentimes, series data contains negative values. Visualizing such data using stacked-like series may lead to unexpected results. To prevent situations of this kind, assign true to the negativesAsZeroes option, and the widget will count all negative values as zeroes.

onArgumentAxisClick

A handler for the argumentAxisClick event.

Type: function(e) |String
Function parameters:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Object
The argument axis.
argument: Date|Number|String
The value of the clicked label.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as the parameter. You can find the value of the clicked label among fields of this object.

Alternatively, you can navigate to a specific URL when the argumentAxisClick event fires. For this purpose, assign this URL to the onArgumentAxisClick option.

Show Example:
jQuery

In this example, the argument axis' labels respond to click.


                                    

                                    

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onDone

A handler for the done event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

onDrawn

A handler for the drawn event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

Assign a callback function to this option if you need to perform specific actions when the widget has finished drawing itself. When implementing this function, you can access the drawn widget using the function's parameter.

onExported

A handler for the exported event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

To perform a custom action after data from the widget is exported, assign a function to this option. For example, this function can notify the user that the exporting has been completed. Within this function, you can use the object passed to it as the parameter.

See Also
  • export - configures client-side export and printing.
  • onExporting - allows you to request exporting details and prevent exporting.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onExporting

A handler for the exporting event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in Knockout and AngularJS approaches.
fileName: String
The name of the file to which the widget is about to be exported.
cancel: Boolean
Assign true to this field if you need to prevent exporting.
Default Value: null

To perform a custom action before data from the widget is exported, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel exporting.

See Also
  • export - configures client-side export and printing.
  • onExported - allows you to notify an end user when exporting is completed.
  • onFileSaving - allows you to access exported data and/or prevent it from being saved into a file on the user's local storage.

onFileSaving

A handler for the fileSaving event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
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
Assign true to this field if you need to prevent the file from being saved.
Default Value: null

To perform a custom action before a file with exported data is saved on the user's local storage, assign a function to this option. Within this function, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel file saving.

See Also
  • export - configures client-side export and printing.
  • onExporting - allows you to request exporting details and prevent exporting.
  • onExported - allows you to notify an end user when exporting is completed.

onIncidentOccurred

A handler for the incidentOccurred event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Object
Information about the occurred incident.

When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.

  • id
    Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
  • type
    Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
  • args
    Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
  • text
    Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
  • widget
    Contains the name of the widget that produced the error or warning.
  • version
    Contains the currently used version of the ChartJS library.
Show Example:
jQuery

In this example, the type of the argument axis values is 'numeric'. Change it to 'string' using the drop-down list below the chart to induce an error. Information about the error will be displayed.


                                    

                                    

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onLegendClick

A handler for the legendClick event.

Type: function(e) |String
Function parameters:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Series
The series to which the clicked legend item belongs.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series to which the clicked legend item belongs. To learn about series members you can use, refer to the description of the Series object.

Alternatively, you can navigate to a specific URL when the legendClick event fires. For this purpose, assign this URL to the onLegendClick option.

To learn more about handling click operations, and to see an example, refer to the Click Handling topic.

Show Example:
jQuery

Click one of the legend items, and the information on the maximum value in the series corresponding to this legend item will appear below.


                                    

                                    

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

Show Example:
jQuery

In this example, use the checkbox below to change the legend's visibility. When you change it, the optionChanged event handler puts information on this event to the container at the bottom.


                                    

                                    

                                    

onPointClick

A handler for the pointClick event.

Type: function(e) |String
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Point
The clicked series point.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked series point. To learn about point's members that you can use, refer to the description of the Point object.

NOTE
A click on a series point causes the seriesClick event to fire after the pointClick event. To prevent this behavior, assign true to the jQueryEvent.cancel field of the object passed to the pointClick event handler as the argument.

Alternatively, you can navigate to a specific URL when the pointClick event fires. For this purpose, assign this URL to the onPointClick option.

To learn more about how to handle click operations, and to see an example, refer to the Click Handling topic.

View Demo

Show Example:
jQuery

Click one of the series points (a segment in a stacked bar) on the chart, and a message with the data on this point will appear below.


                                    

                                    

onPointHoverChanged

A handler for the pointHoverChanged event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose hover state has been changed.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose hover state has been changed. To identify whether this point was hovered over or hovered out, call its isHovered() method. To discover point fields and methods, refer to the Point class description.

To learn more about how to handle hover operations, refer to the Hover Handling topic.

Show Example:
jQuery

In this example, when a series point on the chart is hovered over, the text below shows the information about the selected point.


                                    

                                    

onPointSelectionChanged

A handler for the pointSelectionChanged event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose selection state has been changed.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose selection state has been changed. To identify whether this point was selected or deselected, call its isSelected() method. To discover point fields and methods that you can use, refer to the Point class description.

To learn more about how to handle selection, refer to the Selection Handling topic.

Show Example:
jQuery

In this example, click a series point to select/deselect it. When the point is selected, the text below shows the information about the selected point.


                                    

                                    

onSeriesClick

A handler for the seriesClick event.

Type: function(e) |String
Function parameters:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Series
The clicked series.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked series. To learn about series members that you can use, refer to the description of the Series object.

NOTE
The seriesClick also fires when a user clicks a series point or a legend item, but only if it is not canceled in the pointClick and legendClick event handlers.

Alternatively, you can navigate to a specific URL when the seriesClick event fires. For this purpose, assign this URL to the onSeriesClick option.

To learn more about handling click operations, and to see an example, refer to the Click Handling topic.

Show Example:
jQuery

Click one of the series on the chart, and the information on the maximum value in this series will appear below.


                                    

                                    

onSeriesHoverChanged

A handler for the seriesHoverChanged event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Series
The series whose hover state has been changed.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series whose hover state has been changed. To identify whether this series was hovered over or hovered out, call its isHovered() method. To discover series fields and methods, refer to the Series class description.

To learn more about how to handle hover operations, refer to the Hover Handling topic.

Show Example:
jQuery

In this example, when a series on the chart is hovered over, the text below shows the information about the selected series.


                                    

                                    

onSeriesSelectionChanged

A handler for the seriesSelectionChanged event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Series
The series whose selection state has been changed.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series whose selection state has been changed. To identify whether this series was selected or deselected, call its isSelected() method. To discover series fields and methods, refer to the Series class description.

To learn more about how to handle selection, refer to the Selection Handling topic.

Show Example:
jQuery

In this example, click a chart series to select/deselect it. When the chart series is selected, the text below shows the information about the selected series.


                                    

                                    

onTooltipHidden

A handler for the tooltipHidden event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose tooltip becomes hidden.
Cannot be used in themes.

The point's tooltip becomes invisible when a user hovers the mouse cursor over another series point. In addition, you can hide a tooltip in code, using the hideTooltip() method of the chart or point.

When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. To do this, implement a handling function and assign it to the onTooltipHidden option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip becomes hidden.

Show Example:
jQuery

In this example, when a tooltip is made hidden, the function assigned to the onTooltipHidden option is called. This function displays a message with the corresponding content.


                                    

                                    

onTooltipShown

A handler for the tooltipShown event.

Type: function(e)
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
target: Point
The series point whose tooltip appears.
Cannot be used in themes.

The point's tooltip appears when a user hovers the mouse cursor over the point. In addition, you can show a tooltip in code, using the showTooltip() method of the chart or point.

When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to the onTooltipShown option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip appears.

Show Example:
jQuery

In this example, when a tooltip is shown, the function assigned to the onTooltipShown option is called. This function displays a message with the corresponding content.


                                    

                                    

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.

Type: Array|String
Default Value: 'Default'
Accepted Values: 'Default' | 'Soft Pastel' | 'Harmony Light' | 'Pastel' | 'Bright' | 'Soft' | 'Ocean' | 'Vintage' | 'Violet'

Use this property to set a predefined or custom palette. The colors listed in the specified palette will be used to draw chart series, their points, labels and tooltips. If the number of a series is greater than the number of colors in the palette, palette colors are repeated, but slightly modified.

You can override the color of individual series and their points, labels and tooltips by setting the color property of the corresponding object. In addition, you can define a custom palette to use in your charts. To learn how to do this, refer to the Palettes topic.

When configuring the widget using ASP.NET MVC Wrappers, you can specify this option using the VizPalette enum. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage and Violet.

Show Example:
jQuery

This example shows how to create a custom palette and apply it to a chart.


                                    

                                    

pathModified

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

Type: Boolean
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.

See Also

pointSelectionMode

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

Type: String
Default Value: 'single'
Accepted Values: 'single' | 'multiple'

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

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

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ChartElementSelectionMode enum. This enum accepts the following values: Single and Multiple.

View Demo

Show Example:
jQuery

In this example, click a series point (a segment in a stacked bar) to select/deselect it. The pointSelectionMode option is set to multiple so that you can select multiple points. When selecting a point, the Total value of selected parts number presented below is changed. Click the Clear selected parts button to deselect all points at once.


                                    

                                    

redrawOnResize

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

Type: Boolean
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 instance.

resolveLabelOverlapping

Specifies how the chart must behave when series point labels overlap.

Type: String
Default Value: 'none'
Accepted Values: 'none' | 'hide'

Series point labels display series point values. If your chart contains several series with a large number of points in each, 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.

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the PolarChartResolveLabelOverlapping enum. This enum accepts the following values: None and Hide.

rtlEnabled

Specifies whether or not the widget supports right-to-left representation.

Type: Boolean
Default Value: false
Cannot be used in themes.

The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.

Show Example:
jQuery

The text In this example is written in the Arabic language with the right-to-left reading order enabled. Note that the legend marker and the minus sign of the negative numbers are on the right.


                                    

                                    

series

Specifies options for PolarChart widget series.

Type: Object|Array
Default Value: undefined
Cannot be used in themes.

A series represents a grouping of related data points. The most important characteristic of a series is its type, which determines a particular visual representation of data. You can find more details on each series type in the corresponding topics in the Series help section.

To define a single series, assign an object defining the series to the series configuration object. In the series' object, specify the series type, data source fields, the appearance of the series points and other options.

To show several series, specify series as an array of objects defining series. If you need to set similar values to properties of several series, use the commonSeriesSettings configuration object. It exposes the properties that can be specified for all series at once and for all series of a particular type at once. Note that the values specified for a series individually (in the series array) override the values that are specified for all series (in the commonSeriesSettings object).

NOTE
This option is necessary. If you do not need to specify any of the options within the series object (e.g., when you have specified them within the commonSeriesSettings object), assign at least an empty object to the series field.
Show Example:
jQuery

seriesSelectionMode

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

Type: String
Default Value: 'single'
Accepted Values: 'single' | 'multiple'

To set the series elements to highlight when a series is selected, set the series selectionMode option.

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

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ChartElementSelectionMode enum. This enum accepts the following values: Single and Multiple.

Show Example:
jQuery

In this example, the seriesSelectionMode option is set to multiple. Click a series on the chart to select/deselect this series.


                                    

                                    

seriesTemplate

Defines options for the series template.

Type: Object
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 size of the widget in pixels.

Type: Object
Default Value: undefined

By default, the widget occupies the entire area of the parent container. If you need to set a particular size for the widget, different from the container's size, assign a height and width in pixels to height and width properties of the size object.

Using the size object, you can hide the widget. For this purpose, simply assign 0 to both the height and width of the widget.

theme

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

Type: String
Default Value: 'generic.light'
Accepted Values: 'generic.light' | 'generic.dark' | 'generic.contrast' | 'android5.light' | 'ios7.default' | 'win10.black' | 'win10.white'

Use this property to set a predefined or custom theme. The options defining chart appearance will be set to the values that are set in the specified theme. You can override some of these values within the chart's configuration object.

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

When configuring the widget using ASP.NET MVC Wrappers, specify this option using the VizTheme enum. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, Android5Light, IOS7Default, Win10Black and Win10White.

title

Specifies the widget title.

Type: Object|String

Use this property to set the text to be displayed as the widget title. If you need to specify the title's position in the widget, assign an object to the title property with the required fields specified. In this instance, set the title's text using the text property.

The widget can display additional text in the subtitle. It is placed under the title. Use properties of the subtitle object to assign a text to the subtitle and change its font.

Show Example:
jQuery

In this example, the title text is assigned directly to the title field.


                                    

                                    

tooltip

Configures tooltips.

Type: Object

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.

Show Example:
jQuery

In this example, tooltips are enabled. Hover over any point to see a tooltip.


                                    

                                    

useSpiderWeb

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

Type: Boolean
Default Value: false

In a polar coordinate system, the argument axis is a circle because it tracks a continuous angle change. When the argument in the chart's data source is discrete, you may want to display the argument axis as a discrete axis. For this purpose, set the useSpiderWeb option to true. In this instance, the argument axis, as well as the value axis' grid lines, will be displayed by straight lines between axis ticks/grid lines.

UseSpiderWeb ChartJS

The spider web option is supported in the following series types.

NOTE
A spider web demands that the discreteAxisDivisionMode option is set to 'crossLabels' and the firstPointOnStartAngle option is set to true. Thus, do not change the values of these option so that the spider web saves its look.

View Demo

valueAxis

Specifies value axis options for the PolarChart widget.

Type: Object

For charting, the polar coordinate system is used to determine each point uniquely on a plane through two numbers, the argument and the value of the point. A circular and straight lines (the axis of arguments and the axis of values) are specified to define the coordinates. To define the argument axis, use the argumentAxis configuration object. To define the value axis, use the valueAxis configuration object.

To set the properties of all axes to a common value, use the commonAxisSettings configuration object. It exposes properties that can be specified for all axes simultaneously. Note that the value specified for an axis individually (in the argumentAxis or valueAxis object) overrides the value that specified in the commonAxisSettings object.

Show Example:
jQuery

In this example, the value axis' axisDivisionFactor option is set to 15, and the minValueMargin and maxValueMargin options are set to 0.04.