Top
You are looking at an outdated 7.14.3 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.charts.Pie Improve this Doc

Extends: anychart.core.SeparateChart

Pie (Donut) chart class.
Note: Use anychart#pie method to get an instance of this class:

Methods Overview

Specific settings
connectorLength()Labels connector length.
getType()Returns chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
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.
legend()Legend settings.
title()Title settings.
Coloring
connectorStroke()Labels connectors stroke settings.
fill()Fill settings.
hatchFill()Hatch fill settings.
hoverFill()Fill settings in hover mode.
hoverHatchFill()Hatch fill settings in hover mode.
hoverStroke()Stroke settings in hover mode.
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
stroke()Stroke settings.
Data
data()Data settings.
getSelectedPoints()Getter for the selected points.
getStat()Getter for a statistical value by the key.
group()Grouping of the points
sort()Sort setting.
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
print()Prints all elements.
saveAsCsv()Saves chart data as CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with series data.
Interactivity
explode()Pie slice exploding.
explodeSlice()Explodes slice at index.
explodeSlices()Explodes all slices.
forceHoverLabels()Displaying of the label on hover event.
hover()Setter for the hover state on a slice by index.
interactivity()Interactivity settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
unhover()Removes hover from the pie slice.
Labels
hoverLabels()Labels settings in hover mode.
insideLabelsOffset()Inside labels space settings.
labels()Labels settings.
outsideLabelsCriticalAngle()Outside labels connector critical angle settings.
outsideLabelsSpace()Outside labels space settings.
overlapMode()Overlap mode for labels.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getCenterPoint()Getter for the pie chart center point.
getPixelBounds()Returns pixel bounds.
getPixelExplode()Getter for the explode value.
getPixelInnerRadius()Getter for the pie pixel inner radius.
getPixelRadius()Getter for the pie pixel outer radius.
height()Height setting.
innerRadius()Pie inner radius for Donut chart.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
radius()Pie outer radius
right()Right bound setting.
startAngle()Start angle for the first slice.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
cancelMarquee()Stops current marquee action if any.
container()Getter for the element's container.
draw()Drawing of the chart.
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.
toSvg()Returns SVG string.

Methods Description

animation

Getter for the current animation setting.

Returns:

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

Try it:

Setter for the animation setting by one value.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the 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.core.Chart - Self instance for method chaining.

Try it:

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current 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.core.Chart - Self instance for method chaining.

Try it:

bottom

Getter for element bottom bound setting.

Returns:

number string undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets 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.core.VisualBase - Self instance for method chaining.

Try it:

Setter for the 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.core.VisualBase - Self instance for method chaining.

Try it:

cancelMarquee

Stops current marquee action if any.

Returns:

anychart.core.Chart - Self instance for method chaining.

connectorLength

Getter for the outside labels connector length.

Returns:

number string null - Outside labels connector length.

Try it:

Setter for the outside labels connector length.
Note: Works only with outside labels mode.

Params:

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

Returns:

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

Try it:

connectorStroke

Getter for outside labels connectors stroke settings.

Returns:

anychart.graphics.vector.Stroke - The stroke settings.

Try it:

Setter for outside labels connectors stroke settings. Learn more about stroke settings.
Note: Works only with outside labels mode.

Params:

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

Returns:

anychart.charts.Pie - 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.core.Chart - 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 current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.

Try it:

Setter for the context menu.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.

credits

Getter for the current 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.core.Chart - An instance of the class for method chaining.

data

Getter for the chart data.

Returns:

anychart.data.View - Current data view.

Try it:

Setter for the chart data.
Learn more about mapping at anychart.data.Mapping.

Params:

Name Type Description
value anychart.data.View | anychart.data.Mapping | anychart.data.Set | anychart.data.DataSettings | Array Data for the chart.
csvSettings anychart.enums.TextParsingMode | anychart.data.TextParsingSettings If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Pie - 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.core.Chart - Self instance for method chaining.

explode

Getter for the value of the exploded pie slice.

Returns:

string number - Exploding value.

Try it:

Setter for the value of the exploded pie slice.
Note: Works only with exploded points mode.

Params:

Name Type Default Description
value string | number
15
Value of the expansion/exploding.

Returns:

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

Try it:

explodeSlice

Explodes slice at index.

Params:

Name Type Default Description
index number
Pie slice index that should be exploded or not.
explode boolean
true
Whether to explode.

Returns:

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

explodeSlices

Explodes all slices.

Params:

Name Type Default Description
value boolean
false
Whether to explode.

Returns:

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

Try it:

fill

Getter for the pie fill.

Returns:

anychart.graphics.vector.Fill function - The fill in the normal state.

Try it:

Setter for the pie fill. Learn more about coloring.

Params:

Name Type Default Description
fillFunction function
// return the fill from the default palette.
function() {
  return this.sourceColor;
};
Fill-function, which should look like this:function() { // this: { // index : number - the index of the point // sourceColor : anychart.graphics.vector.Fill - fill of the point // } return myFill; //anychart.graphics.vector.Fill };.

Returns:

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

Try it:

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 array or a string.

Returns:

anychart.charts.Pie - Self instance for method chaining.
Fill color with opacity.

Params:

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

Returns:

anychart.charts.Pie - 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.Pie - 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.Pie - Self instance for method chaining.

Try it:

Params:

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

Returns:

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

Try it:

forceHoverLabels

Getter for the displaying of the label on hover event.

Returns:

boolean - The displaying flag.

Try it:

Setter for the displaying of the label on hover event.

Params:

Name Type Default Description
value boolean
false
Boolean flag.

Returns:

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

Try it:

getCenterPoint

Getter for the pie chart center point.
Note: Works only after anychart.charts.Pie#draw is called.

Returns:

anychart.math.Coordinate - XY coordinate of the current pie chart center.

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.

getPixelExplode

Getter for the explode value.
Note: Works only after anychart.charts.Pie#draw is called.

Returns:

number - Pixel explode value.

Try it:

getPixelInnerRadius

Getter for the pie pixel inner radius. Note: Works only after anychart.charts.Pie#draw is called.

Returns:

number - XY coordinate of the pie center.

Try it:

getPixelRadius

Getter for the pie pixel outer radius.
Note: Works only after anychart.charts.Pie#draw method is called.

Returns:

number - Pixel value of the pie radius.

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 string | anychart.enums.Statistics Key.

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Chart type.

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:

group

Getter for the last values set by grouping function or null.

Returns:

null function - The current grouping function.
See listing
var groupPoints = chart.group();
Setter for the points grouping function.

Params:

Name Type Default Description
value string | null | function
null
Filter function or disable value.

Returns:

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

hatchFill

Getter for the hatch fill settings.

Try it:

Setter for the hatch fill settings.

Params:

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

Returns:

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

Try it:

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Hatch fills palette instance

Try it:

Setter for hatch fill palette settings.
Note: Works only with anychart.charts.Pie#hatchFill method.

Params:

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

Returns:

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

height

Getter for element height setting.

Returns:

number string undefined - Current element's height setting.
Sets element height setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

hover

Setter for the hover state on a slice by index.

Params:

Name Type Description
index number Slice index.

Returns:

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

hoverFill

Getter for the pie slices fill in the hover state.

Returns:

anychart.graphics.vector.Fill function - The fill in the hover state.

Try it:

Setter for the pie slices fill in the hover state. Learn more about coloring.

Params:

Name Type Default Description
fillFunction anychart.graphics.vector.Fill | function
// return lighter fill of the default palette.
function() {
  return anychart.color.lighten(this.sourceColor);
};
Fill-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Fill - fill of the current point // } return myFill; //anychart.graphics.vector.Fill };.

Returns:

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

Try it:

Setter for fill settings in the hover state using an array or a string. Learn more about coloring.

Params:

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

Returns:

anychart.charts.Pie - Self instance for method chaining.
Fill color with opacity.

Params:

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

Returns:

anychart.charts.Pie - 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.Pie - 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.Pie - Self instance for method chaining.

Try it:

Params:

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

Returns:

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

Try it:

hoverHatchFill

Getter for the hover hatch fill settings.

Try it:

Setter for the hover hatch fill settings.

Params:

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

Returns:

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

Try it:

hoverLabels

Getter for the hover data labels.

Returns:

anychart.core.ui.LabelsFactory - LabelsFactory instance.

Try it:

Setter for pie hover data labels.

Params:

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

Returns:

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

hoverStroke

Getter for the pie stroke in the hover state.

Returns:

anychart.graphics.vector.Stroke function - The stroke in the hover state.

Try it:

Setter for the pie stroke in the hover state. 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);
};
Stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

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

Try it:

Setter for the pie stroke in the hover state. Learn more about stroke settings.

Params:

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

Returns:

anychart.charts.Pie - 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 in case of a Donut chart.

Returns:

string number function - The inner radius of a pie chart.

Try it:

Setter for the inner radius in case of a Donut chart.

Params:

Name Type Default Description
value 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.Pie - Self instance for method chaining.

insideLabelsOffset

Getter for the inside labels offset settings.

Returns:

number string null - The inside labels offset.

Try it:

Setter for inside labels space settings.
Note: Works only with inside labels mode.

Params:

Name Type Default Description
value number | string
"50%"
Value to set.

Returns:

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

Try it:

interactivity

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.
Sets interactivity settings for chart.

Params:

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

Returns:

anychart.core.SeparateChart - Self instance for method chaining.

Try it:

label

Getter for chart label.

Params:

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

Returns:

anychart.core.ui.Label - An instance of class.

Try it:

Setter for chart label.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for chart label.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.

labels

Getter for the pie labels.

Returns:

anychart.core.ui.LabelsFactory - LabelsFactory instance.

Try it:

Setter for the pie labels.

Params:

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

Returns:

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

left

Getter for element left bound setting.

Returns:

number string undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

legend

Getter for the current chart legend.

Returns:

anychart.core.ui.Legend - An instance of the class for method chaining.

Try it:

Setter for chart legend setting.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.core.Chart - An instance of the class 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
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
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.core.Chart - 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.core.Chart - 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 maximum height.

Returns:

number string null - Current element's maximum height.
Setter for maximum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for maximum width.

Returns:

number string null - Current element's maximum width.
Setter for maximum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minHeight

Getter for minimum height.

Returns:

number string null - Current element's minimum height.
Setter for minimum height.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for minimum width.

Returns:

number string null - Current element's minimum width.
Setter for minimum width.

Params:

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

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

outsideLabelsCriticalAngle

Getter for the outside labels connector critical angle settings.

Returns:

number string null - Outside labels critical angle.

Try it:

Setter for the outside labels connector critical angle settings.
Note: Works only with outside labels mode.

Params:

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

Returns:

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

Try it:

outsideLabelsSpace

Getter for the outside labels space settings.

Returns:

number string null - Current outside labels space.

Try it:

Setter for the outside labels space settings.
Note: Works only with outside labels mode.

Params:

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

Returns:

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

Try it:

overlapMode

Getter for the overlap mode for labels.

Returns:

anychart.enums.LabelsOverlapMode string - Overlap mode flag.

Try it:

Setter for the overlap mode for labels.

Params:

Name Type Default Description
value anychart.enums.LabelsOverlapMode | string | boolean
"noOverlap"
Value to set.

Returns:

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

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.core.Chart - 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.core.Chart - 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 pie palette.
Setter for the pie palette. Note: You can use predefined palettes from anychart.palettes.

Params:

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

Returns:

anychart.charts.Pie - 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 pie outer radius.

Returns:

string number - Outer radius.

Try it:

Setter for the outer pie radius.

Params:

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

Returns:

anychart.charts.Pie - 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 setting.

Returns:

number string undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

saveAsCsv

Saves chart data as CSV file.

Params:

Name Type Description
chartDataExportMode string | anychart.enums.ChartDataExportMode Data export mode.
csvSettings Object.<string, (string|boolean|undefined)> CSV settings.
filename string File name to save.

Try it:

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
includeTheme boolean If the current theme properties should be included into the result.
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 Excel document.

Params:

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

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
includeTheme boolean If the current theme properties should be included into the result.
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.core.Chart - 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.core.Chart - 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.core.Chart - 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.core.Chart - Self instance for method chaining.

Try it:

Params:

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

Returns:

anychart.core.Chart - 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 anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

sort

Getter for the sorting setting.

Returns:

anychart.enums.Sort - Sort setting.

Try it:

Setter for the sorting setting.
Ascending, Descending and No sorting is supported.

Params:

Name Type Default Description
value anychart.enums.Sort | string
"none"
Value of the sort setting.

Returns:

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

Try it:

startAngle

Getter for the angle of the first slice.

Returns:

string number - The start angle.

Try it:

Setter for the angle of the first slice.

Params:

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

Returns:

anychart.charts.Pie - 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.core.Chart - Self instance for method chaining.

Try it:

stroke

Getter for the pie slices stroke.

Returns:

anychart.graphics.vector.Stroke function - The stroke in the normal state.

Try it:

Setter for the pie slices stroke using function. Learn more about stroke settings.

Params:

Name Type Default Description
fillFunction function
// return stroke from the default palette.
function() {
  return anychart.color.darken(this.sourceColor);
};
Stroke-function, which should look like:function() { // this: { // index : number - the index of the current point // sourceColor : anychart.graphics.vector.Stroke - stroke of the current point // } return myStroke; //anychart.graphics.vector.Stroke };.

Returns:

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

Try it:

Setter for the pie slices stroke. Learn more about stroke settings.

Params:

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

Returns:

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

Try it:

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current 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.core.Chart - Self instance for method chaining.

toCsv

Returns CSV string with series data.

Params:

Name Type Description
chartDataExportMode string | anychart.enums.ChartDataExportMode Data export mode.
csvSettings Object.<string, (string|boolean|undefined)> CSV settings.

Returns:

string - CSV string.

Try it:

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.
includeTheme boolean
false
If the current theme properties should be included into the result.

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.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

string Node - Chart configuration.

tooltip

Getter for tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.

Try it:

Setter for tooltip settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for element top bound setting.

Returns:

number string undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

unhover

Removes hover from the pie slice.

Returns:

anychart.charts.Pie - Self instance 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 setting.

Returns:

number string undefined - Current element's width setting.
Sets element width setting.

Params:

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

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: