AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Sunburst Improve this Doc

Extends: anychart.core.SeparateChart

Sunburst Class.
Note: Use anychart#sunburst method to get an instance of this class.
Learn more about Sunburst Chart

Methods Overview

Specific settings
a11y()Accessibility setting.
calculationMode()Calculation modes.
center()Center state settings.
globalToLocal()Converts the global coordinates to local coordinates.
leaves()Leaves settings.
level()Levels settings.
localToGlobal()Converts the local coordinates to global coordinates.
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
Chart Coloring
animation()Animation settings
background()Background settings.
hatchFillPalette()Hatch fill palette settings.
palette()Palette settings.
Chart Controls
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
title()Title settings.
Coloring
fill()Fill settings.
hatchFill()Hatch fill settings.
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
stroke()Stroke settings.
Data
data()Data settings.
getDrilldownPath()Returns crumbs from the root to the current level.
getSelectedPoints()Getter for the selected points.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
sort()Sort 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
print()Prints all elements.
saveAsCsv()Saves chart data as a CSV file.
saveAsJson()Saves chart config as JSON document.
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.
Interactivity
drillTo()Drills down to target.
drillUp()Drills one level up from current level.
enabled()Element state (enabled or disabled).
interactivity()Interactivity settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
Labels
labels()Labels settings.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height settings.
innerRadius()Inner radius.
left()Left bound settings.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
radius()Outer radius
right()Right bound settings.
startAngle()Start angle.
top()Top bound settings.
width()Width settings.
zIndex()Z-index of the element.
States
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()Redraw chart after changes or not.
cancelMarquee()Stops current marquee action if any.
container()Getter for the element's container.
draw()Drawing of the chart.
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
inMarquee()Gets marquee process running value.
saveAsJpg()Saves the current chart as JPEG image.
saveAsPdf()Saves the current chart as PDF image.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
shareAsJpg()Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()Shares a chart as a SVG file and returns a link to the shared image.
toSvg()Returns SVG string.

Methods Description

a11y

Getter for the accessibility setting.

Returns:

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

Params:

Name Type Description
value boolean | Object Whether to enable accessibility or object with settings.

Returns:

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

animation

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.

Try it:

Setter for animation settings by one value.

Params:

Name Type Default Description
value boolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Setter for animation settings using several parameters.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable animation.
duration number
1000
Duration in milliseconds.

Returns:

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

Try it:

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:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Setter for the chart background.

Params:

Name Type Default Description
value Object
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

Try it:

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

Name Type Default Description
value number | string | null
null
Bottom bound settings for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

Name Type Description
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

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

Try it:

Setter for element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

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

Try it:

calculationMode

Getter for the calculation mode.

Returns:

anychart.enums.SunburstCalculationMode string - Calculation mode.
See listing
var chart = anychart.sunburst(data);
var calculationMode = chart.calculationMode();
Setter for the calculation mode.
The calculateMode() method allows to change the appearance and location of points in the Sunburst chart relative to the calculated values. Learn more about permitted values at anychart.enums.SunburstCalculationMode

Params:

Name Type Default Description
mode anychart.enums.SunburstCalculationMode | string
"ordinal-from-root"
Mode to set.

Returns:

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

Try it:

cancelMarquee

Stops current marquee action if any.

Returns:

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

center

Getter for center settings.

Returns:

anychart.core.ui.Center - Center instance.

Try it:

Setter for center settings.

Params:

Name Type Description
centerSettings Object Settings to set.

Returns:

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

Try it:

container

Getter for the element's container.
Setter for the element's container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

Try it:

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Setter for the context menu.

Params:

Name Type Description
value Object | boolean | null Context menu settings

Returns:

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

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.charts.Sunburst - An instance of the class for method chaining.

data

Getter for the data.

Try it:

Setter for the data.

Params:

Name Type Description
data anychart.data.Tree | anychart.data.TreeView | Array.<Object> Data tree or raw data.
fillMethod anychart.enums.TreeFillingMethod | string Fill method.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

Name Type Description
async boolean Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

drillTo

Drills down to target.

Params:

Name Type Description
target anychart.data.Tree.DataItem | Array | string Target to drill down to.

Try it:

drillUp

Drills one level up from current level.

Try it:

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

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:

Name Type Description
value Object Export settings.

Returns:

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

Try it:

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill function - Chart fill color.
See listing
var chart = anychart.sunburst(data);
var fill = chart.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
color anychart.graphics.vector.Fill Color as an array or a string.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Setter for the fill using function.

Params:

Name Type Default Description
fillFunction function
function() {return this.sourceColor;}
Function that looks like:
function(){
   this.index - internal node index,
   this.level - remoteness from the root node, the root node has level equal 0,
   this.isLeaf - whether the current element is a leaf,
   this.parent - parent node,
   this.point - wrapper over current node, instance of anychart.core.TreeChartPoint
   this.path - an array of the nodes from root to the current node (root node has index 0),
   this.mainColor - node color, that defines sector color,
   this.autoColor - palette color by linear node index,
   this.parentColor - parent node color,
   this.sourceColor - color returned by current state of point (normal, hover or selected),
   this.iterator - linear iterator,
   this.series - sunburst instance chart,
   this.chart - sunburst instance chart
   return fillValue; // type anychart.graphics.vector.Fill
}

Returns:

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

Try it:

Setter for the fill color with opacity. Fill as a string or an object.

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

getDrilldownPath

Returns crumbs from the root to the current level.

Returns:

Array - The current path.

Try it:

getJpgBase64String

Returns JPG as base64 string.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
width number Image width.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Force transparent to white or not.

Try it:

getPdfBase64String

Returns PDF as base64 string.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
paperSizeOrWidth number | string Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth number | boolean Define, is landscape.
x number Offset X.
y number Offset Y.

Try it:

getPixelBounds

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

Returns:

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

getPngBase64String

Returns PNG as base64 string.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
width number Image width.
height number Image height.
quality number Image quality in ratio 0-1.

Try it:

getSelectedPoints

Getter for the selected points.

Returns:

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

Try it:

getStat

Getter for a statistical value by the key.

Params:

Name Type Description
key anychart.enums.Statistics | string Key.

Returns:

* - Statistics value.

Try it:

getSvgBase64String

Returns SVG as base64 string.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
paperSizeOrWidth string | number Paper Size or width.
landscapeOrHeight boolean | string Landscape or height.

Try it:

globalToLocal

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

Params:

Name Type Description
xCoord number Global X coordinate.
yCoord number Global Y coordinate.

Returns:

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

Try it:

hatchFill

Getter for the hatch fill.
See listing
var chart = anychart.sunburst(data);
var hatchFill = chart.hatchFill();
Setter for the hatch fill using boolean. Learn more about hatch fill settings.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable hatch fill or no.

Returns:

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

Try it:

Setter for the hatch fill using function. Learn more about hatch fill settings.

Params:

Name Type Description
hatchFillFunction function Hatch fill function. Function that looks like:
function(){
   this.autoColor - palette color by linear node index,
   this.chart - sunburst instance chart,
   this.index - internal node index,
   this.isLeaf - whether the current element is a leaf,
   this.iterator - linear iterator,
   this.level - remoteness from the root node, the root node has level equal 0,
   this.mainColor - node color, that defines sector color,
   this.parent - parent node,
   this.parentColor - parent node color,
   this.path - an array of the nodes from root to the current node (root node has index 0),
   this.point - wrapper over current node, instance of anychart.core.TreeChartPoint
   this.series - sunburst instance chart,
   this.sourceHatchFill - hatch fill returned by current state of point (normal, hover or selected)

   return hatchFillValue; // type anychart.graphics.vector.HatchFill
}

Returns:

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

Try it:

Setter for the hatch fill using pattern. Learn more about hatch fill settings.

Params:

Name Type Description
patternHatchFill anychart.graphics.vector.PatternFill Pattern hatch fill.

Returns:

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

Try it:

Setter for hatch fill using an instance. Learn more about hatch fill settings.

Params:

Name Type Description
settings anychart.graphics.vector.HatchFill Hatch fill instance.

Returns:

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

Try it:

Setter for the hatch fill using several parameters. Learn more about hatch fill settings.

Params:

Name Type Description
type anychart.graphics.vector.HatchFill.HatchFillType | string PatternFill or HatchFill instance or type of hatch fill.
color string Color.
thickness number Thickness.
size number Pattern size.

Returns:

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

Try it:

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Hatch fills palette instance
See listing
var hatchFillPalette = chart.hatchFillPalette();
Setter for hatch fill palette settings.
Note: Works only with anychart.charts.Sunburst#hatchFill method.

Params:

Name Type Description
settings Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills Chart hatch fill palette settings to set.

Returns:

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

height

Getter for element height settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

Name Type Default Description
value number | string | null
null
Height settings for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
settings Object State settings to set from anychart.core.StateSettings.

Returns:

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

Try it:

inMarquee

Gets marquee process running value.

Returns:

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

innerRadius

Getter for the inner radius.

Returns:

string number function - The inner radius.
See listing
var chart = anychart.sunburst(data);
var innerRadius = chart.innerRadius();
Setter for the inner radius.

Params:

Name Type Default Description
innerRadius string | number | function
0
The value of the inner radius in pixels, percents or function. In general the function should look like this:
function(outerRadius){
  ...
  return NUMBER;
}

Returns:

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

interactivity

Getter for interactivity settings for the chart.

Returns:

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

Params:

Name Type Description
value Object | anychart.enums.HoverMode | string Settings object or boolean value like enabled state.

Returns:

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

Try it:

label

Getter for the chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Setter for the chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Setter for the chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

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

labels

Getter for labels.

Returns:

anychart.core.ui.LabelsFactory - Labels factory instance.

Try it:

Setter for the labels.

Params:

Name Type Default Description
settings Object | boolean | null
true
Chart data labels settings.

Returns:

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

leaves

Getter for leaves settings.

Returns:

anychart.core.sunburst.Level - Leaves instance.

Try it:

Setter for leaves settings.

Params:

Name Type Description
settings Object | boolean Leaves settings.

Returns:

anychart.charts.Sunburst - Self instance for method chaining

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

Name Type Default Description
value number | string | null
null
Left bound setting for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

level

Getter for levels settings.

Params:

Name Type Description
index number Level index.

Returns:

anychart.core.sunburst.Level - Levels settings.

Try it:

Setter for levels settings.

Params:

Name Type Description
index number Level index.
settings Object | boolean Levels settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(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
}
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

localToGlobal

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

Params:

Name Type Description
xCoord number Local X coordinate.
yCoord number Local Y coordinate.

Returns:

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

Try it:

margin

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Sunburst - 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));

Try it:

Setter for the chart margin in pixels using several simple values.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.charts.Sunburst - 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);

Try it:

maxHeight

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

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

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

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

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

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

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

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

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

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

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
settings Object State settings to set from anychart.core.StateSettings.

Returns:

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

Try it:

padding

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Sunburst - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.charts.Sunburst - 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);

Try it:

palette

Getter for the palette.
See listing
var palette = chart.palette();
Setter for the palette. Note: You can use predefined palettes from anychart.palettes.

Params:

Name Type Description
settings anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> Color palette settings.

Returns:

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

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

Try it:

radius

Getter for the outer radius.

Returns:

string number - Outer radius of the chart.
See listing
var chart = anychart.sunburst(data);
var radius = chart.radius();
Setter for the outer radius.

Params:

Name Type Default Description
radius string | number
"45%"
Value of the outer radius.

Returns:

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

Try it:

removeAllListeners

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

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

Name Type Default Description
value number | string | null
null
Right bound setting for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

saveAsCsv

Saves chart data as a CSV file.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<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').
filename string File name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Force transparent to white or not.
filename string File name to save.

Try it:

saveAsJson

Saves chart config as JSON document.

Params:

Name Type Description
filename string File name to save.

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

Name Type Description
paperSizeOrWidthOrOptions number | string | Object Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscape boolean Define, is landscape.
x number Offset X.
y number Offset Y.
filename string File name to save.

Try it:

saveAsPng

Saves the current chart as PNG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
filename string File name to save.

Try it:

saveAsSvg

Saves the current chart as SVG image.

Params:

Name Type Description
paperSize string | Object Paper Size or object with options.
landscape boolean Landscape.
filename string File name to save.

Try it:

Saves the stage as SVG image using width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Try it:

saveAsXlsx

Saves chart data as an Excel document.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
filename string File name to save.

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
filename string File name to save.

Try it:

selectMarqueeFill

Getter for the select marquee fill.

Returns:

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

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

selectMarqueeStroke

Getter for the select marquee stroke.

Returns:

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

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
settings Object State settings to set from anychart.core.StateSettings.

Returns:

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

Try it:

shareAsJpg

Shares a chart as a JPG file and returns a link to the shared image.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
asBase64 boolean Share as base64 file.
width number Image width.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Force transparent to white or not.
filename string File name to save.

Try it:

shareAsPdf

Shares a chart as a PDF file and returns a link to the shared image.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
asBase64 boolean Share as base64 file.
paperSizeOrWidth number | string Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth number | boolean Define, is landscape.
x number Offset X.
y number Offset Y.
filename string File name to save.

Try it:

shareAsPng

Shares a chart as a PNG file and returns a link to the shared image.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
asBase64 boolean Share as base64 file.
width number Image width.
height number Image height.
quality number Image quality in ratio 0-1.
filename string File name to save.

Try it:

shareAsSvg

Shares a chart as a SVG file and returns a link to the shared image.

Params:

Name Type Description
onSuccessOrOptions function | Object Function that is called when sharing is complete or object with options.
onError function Function that is called if sharing fails.
asBase64 boolean Share as base64 file.
paperSizeOrWidth string | number Paper Size or width.
landscapeOrHeight boolean | string Landscape or height.
filename string File name to save.

Try it:

shareWithFacebook

Opens Facebook sharing dialog.

Params:

Name Type Description
captionOrOptions string | Object Caption for the main link or object with options.
link string The URL is attached to the publication.
name string The title for the attached link.
description string Description for the attached link.

Try it:

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

Name Type Description
captionOrOptions string | Object Caption for publication or object with options. If not set 'AnyChart' will be used.
description string Description.

Try it:

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

Name Type Description
linkOrOptions string | Object Attached link or object with options. If not set, the image URL will be used.
description string Description.

Try it:

shareWithTwitter

Opens Twitter sharing dialog.

Try it:

sort

Getter for the sorting settings.

Returns:

anychart.enums.Sort string function - Sort settings.
See listing
var sort = chart.sort();
Setter for the sorting settings using string.
Ascending, Descending and No sorting is supported.

Params:

Name Type Default Description
mode anychart.enums.Sort | string
"none"
Sorting mode.

Returns:

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

Try it:

Setter for the sorting setting using function.

Params:

Name Type Description
sortFunction function Sorting function.

Returns:

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

Try it:

startAngle

Getter for the angle.

Returns:

string number - The start angle.
See listing
var chart = anychart.sunburst(data);
var startAngle = chart.startAngle();
Setter for the angle.

Params:

Name Type Default Description
startAngle string | number
0
Value of the start angle.

Returns:

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

Try it:

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
repeat boolean Whether to start select marquee drawing.

Returns:

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

Try it:

stroke

Getter for the stroke.

Returns:

anychart.graphics.vector.Stroke function - Stroke settings.
See listing
var chart = anychart.sunburst(data);
var stroke = chart.stroke();
Setter for the stroke using function. Learn more about stroke settings.

Params:

Name Type Default Description
strokeFunction function
// return stroke from the default palette.
function() {return anychart.color.darken(this.sourceColor);};
Function that looks like:
function(){
   this.index - internal node index,
   this.level - remoteness from the root node, the root node has level equal 0,
   this.isLeaf - whether the current element is a leaf,
   this.parent - parent node,
   this.point - wrapper over current node, instance of anychart.core.TreeChartPoint
   this.path - an array of the nodes from root to the current node (root node has index 0),
   this.mainColor - node color, that defines sector color,
   this.autoColor - palette color by linear node index,
   this.parentColor - parent node color,
   this.sourceColor - color returned by current state of point (normal, hover or selected),
   this.iterator - linear iterator,
   this.series - sunburst instance chart,
   this.chart - sunburst instance chart
   return strokeValue; // type anychart.graphics.vector.Stroke
}

Returns:

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

Try it:

Setter for the stroke. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toA11yTable

Creates and returns the chart represented as an invisible HTML table.

Params:

Name Type Description
title string Title to set.
asString boolean Defines output: HTML string if True, DOM element if False.

Returns:

Element string null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

Try it:

toCsv

Returns CSV string with the chart data.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<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.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

Name Type Description
title string Title to set.
asString boolean Defines output: HTML string if True, DOM element if False.

Returns:

Element string null - HTML table instance, HTML string or null if parsing chart to table fails.

Try it:

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

Name Type Description
paperSize string | Object Paper Size or object of options.
landscape boolean Landscape.

Returns:

string - SVG content or empty string.

Try it:

Returns SVG string with with determined the width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.

Returns:

string Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Example
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.

Params:

Name Type Description
tooltipSettings Object | boolean | null Tooltip settings to set.

Returns:

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

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

Name Type Default Description
value number | string | null
null
Top bound setting for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

unlisten

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

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

width

Getter for element width settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.charts.Sunburst - Returns self for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: