AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Polar Improve this Doc

Extends: anychart.core.SeparateChart

Polar chart class.
To get the chart use anychart#polar method.
Chart can contain any number of series.
Each series is interactive, you can customize click and hover behavior and other params.
Learn more about Polar Chart

Methods Overview

Specific settings
a11y()Accessibility settings.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
maxPointWidth()Maximum point width settings.
pointWidth()Point width settings.
sortPointsByX()SortPointsByX mode
startAngle()Chart start angle.
Axes and Scales
baseline()Set the baseline by the Y-Scale value.
getXScales()Returns chart X scales.
getYScales()Returns chart Y scales.
xAxis()X-axis settings.
xGrid()Grid settings by X-scale.
xMinorGrid()Minor grid settings by X-scale.
xScale()X-scale settings.
yAxis()Y-axis settings.
yGrid()Grid settings by Y-scale.
yMinorGrid()Minor grid settings by Y-scale.
yScale()Y-scale settings.
Chart Coloring
hatchFillPalette()Hatch fill settings.
markerPalette()Markers palette settings.
palette()Palette settings.
Chart Controls
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
Coloring
background()Background settings.
selectRectangleMarqueeFill()Select marquee fill settings.
startRectangleMarqueeStroke()Stroke settings.
Data
data()Data settings.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener
removeAllListeners()Removes all listeners.
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key.
Export
exports()Exports settings
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
print()Prints chart.
saveAsCsv()Saves chart data as a CSV file.
saveAsJpg()Saves the chart as JPEG image.
saveAsJson()Saves chart config as JSON document.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
toCsv()Returns CSV string with the chart data.
toSvg()Returns SVG string.
Interactivity
hovered()Hovered state settings.
interactivity()Interactivity settings.
normal()Normal state settings.
selected()Selected state settings.
startSelectRectangleMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
Point Elements
getSelectedPoints()Getter for the selected points.
labels()Labels settings.
maxLabels()Maximum labels settings.
minLabels()Minimum labels settings.
Series
area()Adds Area series.
column()Adds Column series.
getSeries()Gets series by index.
line()Adds Line series.
marker()Adds Marker series.
polygon()Adds Polygon series.
polyline()Adds Polyline series.
rangeColumn()Adds Range Column series.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds of the chart.
getPlotBounds()Getter for the data bounds of the chart.
height()Height setting.
innerRadius()Polar inner radius.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height setting.
maxWidth()Maximum width setting.
minHeight()Minimum height setting.
minWidth()Minimum width setting.
padding()Padding settings.
right()Right bound settings.
top()Top bound settings.
width()Width setting.
zIndex()Z-index of the chart.
Specific Series Settings
addSeries()Adds series to the chart.
barGroupsPadding()Settings for the space between bar groups.
barsPadding()Settings for the space between bars.
defaultSeriesType()Default series type.
getSeriesAt()Getter for the series by its index.
getSeriesCount()Returns series count.
removeAllSeries()Removes all series from chart.
removeSeries()Removes one of series from chart by its id.
removeSeriesAt()Removes one of series from chart by its index.
XML/JSON
toJson()Returns chart configuration as JSON object or string.
toXml()Returns chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()Redraw chart after changes or not.
cancelMarquee()Stops marquee action if any.
container()Chart container
draw()Chart drawing.
fullScreen()Fullscreen mode.
id()Chart id.
inMarquee()Gets marquee process running value.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.

Methods Description

a11y

Getter for the accessibility settings.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility settings.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

addSeries

Adds series to the chart.

Params:

NameTypeDescription
var_argsanychart.data.View | anychart.data.Set | ArrayChart series data.

Returns:

Array.<anychart.core.polar.series.Base> - Array of created series.

area

Adds Area series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
false
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Area - An instance of the created series.

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background settings.

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

barGroupsPadding

Getter for the space between bar groups on the ordinal scale by ratio of bars width.

Returns:

number - Bar groups padding.
See listing
var barsPadding = chart.barGroupsPadding();
Setter for the space between bar groups on the ordinal scale by ratio of bars width.

Params:

NameTypeDefaultDescription
paddingnumber
0
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

barsPadding

Getter for the space between bars on the ordinal scale by ratio of bars width.

Returns:

number - Bars padding.
See listing
var barsPadding = chart.barsPadding();
Setter for the space between bars on the ordinal scale by ratio of bars width.

Params:

NameTypeDefaultDescription
paddingnumber
0
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

baseline

Getter for the chart baseline.

Returns:

number - The baseline value by the Y-Scale.
See listing
var chart = anychart.polar();
var baseline = chart.baseline();
Setter for the chart baseline.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.

Params:

NameTypeDescription
valuenumberY-Scale value for the baseline.

Returns:

anychart.charts.Polar - Self instance for method chaining.

bottom

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound settings.
See listing
var bottom = chart.bottom();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
bottomnumber | string | nullBottom bound for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

bounds

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
See listing
var bounds = chart.bounds();
Setter for the chart bounds using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of teh chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for the chart bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.charts.Polar - Self instance for method chaining.

cancelMarquee

Stops marquee action if any.

Returns:

anychart.charts.Polar - Self instance for method chaining.

column

Adds Column series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
true
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Column - An instance of the created series.

container

Getter for the chart container.
Setter for the chart container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.
Setter for the context menu.

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

anychart.charts.Polar - Self instance for method chaining.

credits

Getter for chart credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Credits settings

Returns:

anychart.charts.Polar - Self instance for method chaining.

data

Getter for the chart data.

Returns:

anychart.data.View - Data view.
See listing
var chart = anychart.polar();
var data = chart.data();
Setter for the chart data.

Params:

NameTypeDescription
dataanychart.data.Set | anychart.data.DataSettings | ArrayData for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

defaultSeriesType

Getter for the default polar series type.

Returns:

string - Default series type.
Setter for the polar default series type.

Params:

NameTypeDescription
typeanychart.enums.PolarSeriesType | stringDefault series type.

Returns:

anychart.charts.Polar - Self instance for method chaining.

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

anychart.charts.Polar - Self instance for method chaining.

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

NameTypeDescription
settingsObjectExport settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

anychart.charts.Polar - Self instance for method chaining.

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

getPixelBounds

Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the chart.

getPlotBounds

Getter for the data bounds of the chart.
Note: Works only after anychart.charts.Polar#draw is called.

Returns:

anychart.math.Rect - The data bounds of the chart.

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getSelectedPoints

Getter for the selected points.

Returns:

Array.<anychart.core.Point> - An array of the selected points.

getSeries

Getter for the series by its id.

Params:

NameTypeDescription
idnumber | stringId of the series.

Returns:

anychart.core.polar.series.Base - An instance of the created series.

getSeriesAt

Getter for the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

anychart.core.polar.series.Base - An instance of the created series.

getSeriesCount

Returns series count.

Returns:

number - Number of series.

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getType

Returns chart type.

Returns:

string - Chart type.

getXScales

Returns chart X scales.

Returns:

Array - An array of all X scales (including axes, grids, and axis markers scales).

getYScales

Returns chart Y scales.

Returns:

Array - An array of all Y scales (including axes, grids, and axis markers scales).

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.charts.Polar#draw is called.

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - The chart hatch fill palette.
Setter for hatch fill palette settings.

Params:

NameTypeDescription
settingsArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsChart hatch fill palette settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

height

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.
See listing
var height = chart.height();
Setter for the chart's height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

anychart.charts.Polar - Self instance for method chaining.

inMarquee

Gets marquee process running value.

Returns:

boolean - Returns true if there is a marquee process running.

innerRadius

Getter for the inner radius.

Returns:

number | string - Inner radius.
See listing
var innerRadius =  chart.innerRadius();
Setter for the inner radius in pixels or percent of main radius.

Params:

NameTypeDefaultDescription
radiusnumber | string
0
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

interactivity

Getter for the interactivity settings.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.
Setter for the interactivity settings.

Params:

NameTypeDescription
settingsObject | anychart.enums.HoverMode | stringSettings object or boolean value like enabled state.

Returns:

anychart.charts.Polar - Self instance for method chaining.

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.
Setter for the chart label.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for chart label using index.

Params:

NameTypeDefaultDescription
indexstring | number
0
Label index.
settingsnull | boolean | Object | string
false
Chart label settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDescription
settingsObject | boolean | nullSeries data labels settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

left

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.
See listing
var left = chart.left();
Setter for the chart's left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.
Setter for the chart legend settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Legend settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

line

Adds Line series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
false
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Line - An instance of the created series.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

Converts the local coordinates to global coordinates. Note: Works only after anychart.charts.Polar#draw is called.

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

margin

Setter for the chart margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, "15px", "5px", 12);

marker

Adds Marker series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
true
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Marker - An instance of the created series.

markerPalette

Getter for the markers palette settings.

Returns:

anychart.palettes.Markers - The markers palette.
Setter for the markers palette settings.

Params:

NameTypeDescription
settingsanychart.palettes.Markers | Object | Array.<(anychart.enums.MarkerType|string)>Marker palette to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

maxHeight

Getter for the chart's maximum height.

Returns:

number | string | null - Chart's maximum height.
See listing
var maxHeight = chart.maxHeight();
Setter for the chart's maximum height.

Params:

NameTypeDefaultDescription
maxHeightnumber | string | null
null
Maximum height to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for maximum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMaximum labels settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

maxPointWidth

Getter for the maximum point width.

Returns:

string | number - The maximum point width pixel value.
See listing
var maxPointWidth = chart.maxPointWidth();
Setter for the maximum point width.

Params:

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

anychart.charts.Polar - Self instance for method chaining.

maxWidth

Getter for the chart's maximum width.

Returns:

number | string | null - Chart's maximum width.
See listing
var maxWidth = chart.maxWidth();
Setter for the chart's maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

minHeight

Getter for the chart's minimum height.

Returns:

number | string | null - Chart's minimum height.
See listing
var minHeight = chart.minHeight();
Setter for the chart's minimum height.

Params:

NameTypeDefaultDescription
minHeightnumber | string | null
null
Minimum height to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for minimum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMinimum labels settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

minWidth

Getter for the chart's minimum width.

Returns:

number | string | null - Chart's minimum width.
See listing
var minWidth = chart.minWidth();
Setter for the chart's minimum width.

Params:

NameTypeDefaultDescription
minWidthnumber | string | null
null
Minimum width to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

padding

Setter for the chart paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
See listing.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, "15px", 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, "15%", "5px", 12);

palette

Getter for the chart colors palette.
Setter for the series colors palette.
Note: You can use predefined palettes from anychart.palettes.

Params:

NameTypeDescription
settingsanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Chart palette to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

pointWidth

Getter for the point width settings.

Returns:

string | number - The point width pixel value.
See listing
var pointWidth = chart.pointWidth();
Setter for the point width settings.

Params:

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

anychart.charts.Polar - Self instance for method chaining.

polygon

Adds Polygon series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
true
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Polygon - An instance of the created series.

polyline

Adds Polyline series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
true
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.Polyline - An instance of the created series.

print

Prints chart.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
landscapeboolean
false
Flag of landscape.

rangeColumn

Adds Range Column series.

Params:

NameTypeDefaultDescription
dataanychart.data.View | anychart.data.Set | Array | string
Data for the series.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings
true
If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.polar.series.RangeColumn - An instance of the created series.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

removeAllSeries

Removes all series from chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

anychart.charts.Polar - Self instance for method chaining.

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Getter for the chart's right bound setting.

Returns:

number | string | undefined - Chart's right bound setting.
See listing
var right = chart.right();
Setter for the chart's right bound setting.

Params:

NameTypeDescription
rightnumber | string | nullRight bound for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*))>CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').
filenamestringFile name to save.

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanDefine, should we force transparent to white background.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the chart as SVG image using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

selectRectangleMarqueeFill

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.
See listing
var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.charts.Polar - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

sortPointsByX

Getter for the sortPointsByX mode.

Returns:

boolean - SortPointsByX mode.
See listing
var mode = chart.sortPointsByX();
Setter for the sortPointsByX mode. If the points of series should be sorted by X before drawing.

Params:

NameTypeDefaultDescription
enabledboolean
false
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

startAngle

Getter for the chart start angle.

Returns:

string | number - The chart start angle.
Setter for the chart start angle.

Params:

NameTypeDefaultDescription
anglestring | number
0
Value to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

startRectangleMarqueeStroke

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.
See listing.
var startRectangleMarqueeStroke = chart.startRectangleMarqueeStroke();
Setter for the select marquee stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.Polar - Self instance for method chaining.

startSelectRectangleMarquee

Starts select marquee drawing. Note: Works only after anychart.charts.Polar#draw is called.

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

anychart.charts.Polar - Self instance for method chaining.

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.charts.Polar - Self instance for method chaining.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*)|Object)>CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').

Returns:

string - CSV string.

toJson

Returns chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Returns chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for the tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for tooltip settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings.

Returns:

anychart.charts.Polar - Self instance for method chaining.

top

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound settings.
See listing
var top = chart.top();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
topnumber | string | nullTop bound for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.
See listing
var width = chart.width();
Setter for the chart's width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the chart.

Returns:

anychart.charts.Polar - Self instance for method chaining.

xAxis

Getter for the chart X-axis.

Returns:

anychart.core.axes.Polar - X-axis instance by index.
Setter for the chart X-axis.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart axis settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

xGrid

Getter for the chart grid by X-scale.

Params:

NameTypeDescription
indexnumberChart grid index. If not set - creates a new instance and adds it to the end of grids array.

Returns:

anychart.core.grids.Polar - Grid instance by index.
Setter for the chart grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for chart grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullChart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

xMinorGrid

Getter for the chart minor grid by X-scale.

Params:

NameTypeDescription
indexnumberChart grid index. If not set - creates a new instance and adds it to the end of grid array.

Returns:

anychart.core.grids.Polar - Minor grid instance by index.
Setter for the chart minor grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for the chart minor grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullChart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

xScale

Getter for the default chart X scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.
Setter for the chart X scale.

Params:

NameTypeDefaultDescription
settingsObject | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Linear
X Scale to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

yAxis

Getter for the chart Y-axis.

Returns:

anychart.core.axes.Radial - Axis instance by index.
Setter for the chart Y-axis.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart axis settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

yGrid

Getter for the chart grid by Y-scale.

Params:

NameTypeDescription
indexnumberChart grid index. If not set - creates a new instance and adds it to the end of grids array.

Returns:

anychart.core.grids.Polar - Grid instance by index.
Setter for the chart grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for chart grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullChart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

yMinorGrid

Getter for the chart minor grid by Y-scale.

Params:

NameTypeDescription
indexnumberChart grid index. If not set - creates a new instance and adds it to the end of grid array.

Returns:

anychart.core.grids.Polar - Minor grid instance by index.
Setter for the chart minor grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.
Setter for the chart minor grid by index.

Params:

NameTypeDescription
indexnumberChart grid index.
settingsObject | boolean | nullChart grid settings to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

yScale

Getter for the default chart Y scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.
Setter for the chart Y scale.

Params:

NameTypeDefaultDescription
valueObject | anychart.enums.ScatterScaleTypes | string | anychart.scales.ScatterBase
anychart.scales.Linear
Y Scale to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.

zIndex

Getter for the Z-index of the chart.

Returns:

number - Chart Z-index.
See listing
var zIndex = chart.zIndex();
Setter for the Z-index of the chart.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Z-index to set.

Returns:

anychart.charts.Polar - Self instance for method chaining.