JavaScript/jQuery PolarChart Methods

The name of the file to which the UI component is about to be exported.

format:

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

View Demo

getAllSeries()

Gets all the series.

Return Value:

Array<Series>

The Series objects.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The UI component's container.

Return Value:

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the PolarChart instance found in an element with the myPolarChart ID:

// Modular approach
import PolarChart from "devextreme/viz/polar_chart";
...
let element = document.getElementById("myPolarChart");
let instance = PolarChart.getInstance(element) as PolarChart;

// Non-modular approach
let element = document.getElementById("myPolarChart");
let instance = DevExpress.viz.dxPolarChart.getInstance(element);

getSeriesByName(seriesName)

Gets a series with a specific name.

Parameters:

seriesName: any

The series' name.

Return Value:

Series

The Series object; null if nothing is found.

getSeriesByPos(seriesIndex)

Gets a series with a specific index.

Parameters:

seriesIndex:

Number

The series' index.

Return Value:

Series

The Series object.

getSize()

Gets the current UI component size.

Return Value:

Size

The current UI component size.

Returns an object with the following fields.

width
The width of the UI component in pixels.
height
The height of the UI component in pixels.

getValueAxis()

Gets a value axis.

Return Value:

Chart Axis

A value axis.

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the UI component is ready, you can hide it from code at the required moment using this method.

hideTooltip()

Hides all UI component tooltips.

Use this method to hide all UI component tooltips programmatically.

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

This UI component's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

option()

Gets all UI component properties.

Return Value:

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:

options:

Propertieswith their new values.

print()

Opens the browser's print window.

View Demo

refresh()

Reloads data and repaints the UI component.

The UI component cannot track changes a third party makes in the data source. Call this method to update data in the UI component in this case.

render()

Redraws the UI component.

Normally, the UI component redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the UI component's container is resized. For this purpose, call the render() method.

render(renderOptions)

Redraws the UI component.

Parameters:

renderOptions:

Rendering properties.

You can call the render method without parameters after the size or visibility of the UI component container is changed. Alternatively, call the render method passing an object as the parameter. This object must contain the force field set to 'true'. In addition, you can use this object to specify whether or not to perform animation on redrawing with the animate field.

The following code sample illustrates the example of the object that can be passed to the render method.

JavaScript

var renderOptions = {
    force: true, // forces redrawing
    animate: false // redraws the UI component without animation
}

resetOption(optionName)

Resets an property to its default value.

Parameters:

optionName:

An property's name.

resetVisualRange()

Resets the value axis' visual range to the data range or to the whole range if it is within the data range.

showLoadingIndicator()

Shows the loading indicator.

svg()

Gets the UI component's SVG markup.

Return Value: