AmPieChart – amCharts Version 2 Documentation

Type class

AmPieChart class creates pie/donut chart. In order to display pie chart you need to set at least three properties - dataProvider, titleField and valueField. For example:

var chartData = [{title:"Pie I have eaten",value:70},{title:"Pie I haven't eaten",value:30}];			
var chart = new AmCharts.AmPieChart();
chart.valueField = "value";
chart.titleField = "title";
chart.dataProvider = chartData;
chart.write("chartdiv");

Inheritance

AmPieChart extends AmChart.

AmPieChart is not extended by any other symbol.

Properties

alphaField #	Type `string` Name of the field in chart's dataProvider which holds slice's alpha.
angle #	Type `number` Default `0` Pie lean angle (for 3D effect). Valid range is 0 - 90.
balloonText #	Type `string` Default `[[title]]: [[percents]]% ([[value]])n[[description]]` Balloon text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]].
chartData #	Type `array` Default Read-only. Array of Slice objects.
colorField #	Type `string` Name of the field in chart's dataProvider which holds slice's color.
colors #	Type `array` Default `["#FF0F00", "#FF6600", "#FF9E01", "#FCD202", "#F8FF01", "#B0DE09", "#04D215", "#0D8ECF", "#0D52D1", "#2A0CD0", "#8A0CCF", "#CD0D74", "#754DEB", "#DDDDDD", "#999999", "#333333", "#000000", "#57032A", "#CA9726", "#990000", "#4B0C25"]` Specifies the colors of the slices, if the slice color is not set. If there are more slices than colors in this array, the chart picks random color.
depth3D #	Type `number` Default `0` Depth of the pie (for 3D effect).
descriptionField #	Type `string` Name of the field in chart's dataProvider which holds a string with description.
gradientRatio #	Type `Array of numbers` Default Example: [-0.2,0.2]. Will make slices to be filled with color gradients.
groupedAlpha #	Type `number` Default `1` Opacity of the group slice. Value range is 0 - 1.
groupedColor #	Type `string` Default Color of the group slice. The default value is not set - this means the next available color from "colors" array will be used.
groupedDescription #	Type `string` Default Description of the group slice.
groupedPulled #	Type `boolean` Default `false` If this is set to true, the group slice will be pulled out when the chart loads.
groupedTitle #	Type `string` Default `Other` Title of the group slice.
groupPercent #	Type `number` Default `0` If there is more than one slice whose percentage of the pie is less than this number, those slices will be grouped together into one slice. This is the "other" slice. It will always be the last slice in a pie.
hideLabelsPercent #	Type `number` Default `0` Slices with percent less then hideLabelsPercent won't display labels This is useful to avoid cluttering up the chart, if you have a lot of small slices. 0 means all labels will be shown.
hoverAlpha #	Type `number` Default `1` Opacity of a hovered slice. Value range is 0 - 1.
innerRadius #	Type `Number/String` Default `0` Inner radius of the pie, in pixels or percents.
labelRadius #	Type `number` Default `30` The distance between the label and the slice, in pixels. You can use negative values to put the label on the slice.
labelRadiusField #	Type `string` Name of the field in dataProvider which specifies the length of a tick. Note, the chart will not try to arrange labels automatically if this property is set.
labelsEnabled #	Type `boolean` Default `true` Specifies whether data labels are visible.
labelText #	Type `string` Default `[[title]]: [[percents]]%` Label text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]].
labelTickAlpha #	Type `number` Default `0.2` Label tick opacity. Value range is 0 - 1.
labelTickColor #	Type `string` Default `#000000` Label tick color.
marginBottom #	Type `number` Default `5` Bottom margin of the chart.
marginLeft #	Type `number` Default `0` Left margin of the chart.
marginRight #	Type `number` Default `0` Right margin of the chart.
marginTop #	Type `number` Default `5` Top margin of the chart.
minRadius #	Type `number` Default `10` Minimum radius of the pie, in pixels.
outlineAlpha #	Type `number` Default `0` Pie outline opacity. Value range is 0 - 1.
outlineColor #	Type `string` Default `#FFFFFF` Pie outline color.
outlineThickness #	Type `number` Default `1` Pie outline thickness.
pieAlpha #	Type `number` Default `1` Opacity of the slices. You can set the opacity of individual slice too.
pieBaseColor #	Type `string` Default Color of the first slice. All the other will be colored with darker or brighter colors.
pieBrightnessStep #	Type `number` Default `30` Lightness increase of each subsequent slice. This is only useful if pieBaseColor is set. Use negative values for darker colors. Value range is from -255 to 255.
pieX #	Type `Number/String%` You can set fixed position of a pie center, in pixels or in percents.
pieY #	Type `Number/String%` You can set fixed position of a pie center, in pixels or in percents.
pulledField #	Type `string` Name of the field in chart's dataProvider which holds a boolean value telling the chart whether this slice must be pulled or not.
pullOutDuration #	Type `number` Default `1` Pull out duration, in seconds.
pullOutEffect #	Type `string` Default `bounce` Pull out effect. Possible values are ">", "<", elastic" and "bounce".
pullOutOnlyOne #	Type `boolean` Default `false` If this is set to true, only one slice can be pulled out at a time. If the viewer clicks on a slice, any other pulled-out slice will be pulled in.
pullOutRadius #	Type `Number/String` Default `20%` Pull out radius, in pixels or percents
radius #	Type `Number/String` Default Radius of a pie, in pixels or percents. By default, radius is calculated automatically.
sequencedAnimation #	Type `boolean` Default `false` Specifies whether the animation should be sequenced or all slices should appear at once.
startAlpha #	Type `number` Default `1` Initial opacity of all slices. If you set startDuration higher than 0, slices will fade in from startAlpha.
startAngle #	Type `number` Default `90` Angle of the first slice, in degrees. This will work properly only if "depth3D" is set to 0. If "depth3D" is greater than 0, then there can be two angles only: 90 and 270. Value range is 0-360.
startDuration #	Type `number` Default `1` Duration of the animation, in seconds.
startEffect #	Type `string` Default `bounce` Animation effect. Possible values are ">", "<", "elastic" and "bounce".
startRadius #	Type `Number/String` Default `500%` Radius of the positions from which the slices will fly in.
titleField #	Type `string` Name of the field in chart's dataProvider which holds slice's title.
urlField #	Type `string` Name of the field in chart's dataProvider which holds url which would be accessed if the user clicks on a slice.
urlTarget #	Type `string` Default `_self` If url is specified for a slice, it will be opened when user clicks on it. urlTarget specifies target of this url. Use _blank if you want url to be opened in a new window.
valueField #	Type `string` Name of the field in chart's dataProvider which holds slice's value.
visibleInLegendField #	Type `string` Name of the field in chart's dataProvider which holds boolean variable defining whether this data item should have an entry in the legend.
backgroundColor #	Type `string` Default `#FFFFFF` Inherited from `AmChart` Background color. You should set backgroundAlpha to >0 value in order background to be visible. We recommend setting background color directly on a chart's DIV instead of using this property.
balloon #	Type `AmBalloon` Default `AmBalloon` Inherited from `AmChart` The chart creates AmBalloon class itself. If you want to customize balloon, get balloon instance using this property, and then change balloon's properties.
borderAlpha #	Type `number` Default `0` Inherited from `AmChart` Opacity of chart's border. Value range is 0 - 1.
borderColor #	Type `string` Default `#000000` Inherited from `AmChart` Color of chart's border. You should set borderAlpha >0 in order border to be visible. We recommend setting border color directly on a chart's DIV instead of using this property.
color #	Type `string` Default `#000000` Inherited from `AmChart` Text color.
dataProvider #	Type `array` Inherited from `AmChart` Array of data objects, for example: [{country:"US", value:524},{country:"UK", value:624},{country:"Lithuania", value:824}]. You can have any number of fields and use any field names. In case of AmMap, data provider should be MapData object.
fontFamily #	Type `string` Default `Verdana` Inherited from `AmChart` Font family.
fontSize #	Type `number` Default `11` Inherited from `AmChart` Font size.
height #	Type `Number/String` Default `100%` Inherited from `AmChart` Height of a chart. "100%" means the chart's height will be equal to it's container's (DIV) height and will resize if height of the container changes. Set a number instead of percents if your chart's size needs to be fixed.
legendDiv #	Type `DIV object` Inherited from `AmChart` Reference to the div of the legend.
numberFormatter #	Type `object` Default `{ precision:-1, decimalSeparator:'.', thousandsSeparator:', ' }` Inherited from `AmChart` Object with precision, decimalSeparator and thousandsSeparator set which will be used for number formatting. Precision set to -1 means that values won't be rounded.
panEventsEnabled #	Type `boolean` Default `false` Inherited from `AmChart` This setting affects touch-screen devices only. If a chart is on a page, and panEventsEnabled are set to true, the page won't move if the user touches the chart first. If a chart is big enough and occupies all the screen of your touch device, the user won’t be able to move the page at all. That's why the default value is "false". If you think that selecting/panning the chart or moving/pinching the map is a primary purpose of your users, you should set panEventsEnabled to true.
pathToImages #	Type `string` Inherited from `AmChart` Specifies path to the folder where images like resize grips, lens and similar are.
percentFormatter #	Type `object` Default `{ precision:2, decimalSeparator:'.', thousandsSeparator:', ' }` Inherited from `AmChart` Object with precision, decimalSeparator and thousandsSeparator set which will be used for formatting percent values.
prefixesOfBigNumbers #	Type `array` Default `[{ number:1e+3, prefix:"k" }, { number:1e+6, prefix:"M" }, { number:1e+9, prefix:"G" }, { number:1e+12, prefix:"T" }, { number:1e+15, prefix:"P" }, { number:1e+18, prefix:"E" }, { number:1e+21, prefix:"Z" }, { number:1e+24, prefix:"Y" }]` Inherited from `AmChart` Prefixes which are used to make big numbers shorter: 2M instead of 2000000, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true.
prefixesOfSmallNumbers #	Type `array` Default `[{ number:1e-24, prefix:"y" }, { number:1e-21, prefix:"z" }, { number:1e-18, prefix:"a" }, { number:1e-15, prefix:"f" }, { number:1e-12, prefix:"p" }, { number:1e-9, prefix:"n" }, { number:1e-6, prefix:"μ" }, { number:1e-3, prefix:"m" }]` Inherited from `AmChart` Prefixes which are used to make small numbers shorter: 2μ instead of 0.000002, etc. Prefixes are used on value axes and in the legend. To enable prefixes, set usePrefixes property to true.
usePrefixes #	Type `boolean` Default `false` Inherited from `AmChart` If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties.
version #	Type `string` Inherited from `AmChart` Read-only. Indicates current version of a script.
There are 18 inherited items currently hidden from this list.

Methods

addLabel( `x`, `y`, `text`, `align`, `size`, `color`, `rotation`, `alpha`, `bold`, `url` ) #	Returns `void` Inherited from `AmChart` Adds a label on a chart. You can use it for labeling axes, adding chart title, etc. x and y coordinates can be set in number, percent, or a number with ! in front of it - coordinate will be calculated from right or bottom instead of left or top. x - horizontal coordinate y - vertical coordinate text - label's text align - alignment (left/right/center) size - text size color - text color rotation - angle of rotation alpha - label alpha bold - specifies if text is bold (true/false), url - url of a
addLegend( `legend`, `legendDivID` ) #	Returns `void` Inherited from `AmChart` Adds a legend to the chart. By default, you don't need to create div for your legend, however if you want it to be positioned in some different way, you can create div anywhere you want and pass id or reference to your div as a second parameter. (NOTE: This method will not work on StockPanel.) legend - AmLegend, legendDivID - id or reference to legend div (optional)
addListener( `type`, `handler` ) #	Returns `void` Inherited from `AmChart` Adds event listener to the object. type - string like 'dataUpdated' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens
addTitle( `text`, `size`, `color`, `alpha`, `bold` ) #	Returns `void` Inherited from `AmChart` Adds title to the top of the chart. Pie, Radar positions are updated so that they won't overlap. Plot area of Serial/XY chart is also updated unless autoMargins property is set to false. You can add any number of titles - each of them will be placed in a new line. To remove titles, simply clear titles array: chart.titles = []; and call chart.validateNow() method. text - text of a title size - font size color - title color alpha - title opacity bold - boolean value indicating if title should be bold.
animateAgain() #	Returns `void` You can trigger the animation of the pie chart.
clear() #	Returns `void` Inherited from `AmChart` Clears the chart area, intervals, etc.
clearLabels() #	Returns `void` Inherited from `AmChart` Removes all labels added to the chart.
clickSlice( `index` ) #	Returns `void` You can trigger the click on a slice from outside. index - the number of a slice or Slice object.
hideSlice( `index` ) #	Returns `void` Hides slice. index - the number of a slice or Slice object.
invalidateSize() #	Returns `void` Inherited from `AmChart` Use this method to force the chart to resize to it's current container size.
removeLegend() #	Returns `void` Inherited from `AmChart` Removes chart's legend.
removeListener( `chart`, `type`, `handler` ) #	Returns `void` Inherited from `AmChart` Removes event listener from chart object. chart - chart object, type - event name, handler - method
rollOutSlice( `index` ) #	Returns `void` You can simulate roll-out of a slice from outside. index - the number of a slice or Slice object.
rollOverSlice( `index` ) #	Returns `void` You can simulate roll-over a slice from outside. index - the number of a slice or Slice object.
showSlice( `index` ) #	Returns `void` Shows slice. index - the number of a slice or Slice object.
validateData() #	Returns `void` Inherited from `AmChart` This method should be called after data in your data provider changed or a new array was set to dataProvider. After calling this method the chart will parse data and redraw.
validateNow() #	Returns `void` Inherited from `AmChart` This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called.
write( `container` ) #	Returns `void` Inherited from `AmChart` Adds chart to the specified DIV. container - id of a DIV or DIV object which will hold the chart
There are 12 inherited items currently hidden from this list.

addLabel(
  x,
  y,
  text,
  align,
  size,
  color,
  rotation,
  alpha,
  bold,
  url
)

Returns void

Inherited from AmChart

Adds a label on a chart. You can use it for labeling axes, adding chart title, etc. x and y coordinates can be set in number, percent, or a number with ! in front of it - coordinate will be calculated from right or bottom instead of left or top.

x - horizontal coordinate y - vertical coordinate text - label's text align - alignment (left/right/center) size - text size color - text color rotation - angle of rotation alpha - label alpha bold - specifies if text is bold (true/false), url - url of a

addLegend(
legend,
legendDivID
)

Returns void

Inherited from AmChart

Adds a legend to the chart. By default, you don't need to create div for your legend, however if you want it to be positioned in some different way, you can create div anywhere you want and pass id or reference to your div as a second parameter. (NOTE: This method will not work on StockPanel.) legend - AmLegend, legendDivID - id or reference to legend div (optional)

addListener(
type,
handler
)

Returns void

Inherited from AmChart

Adds event listener to the object.

type - string like 'dataUpdated' (should be listed in 'events' section of this class or classes which extend this class). handler - function which is called when event happens

addTitle(
  text,
  size,
  color,
  alpha,
  bold
)

Returns void

Inherited from AmChart

Adds title to the top of the chart. Pie, Radar positions are updated so that they won't overlap. Plot area of Serial/XY chart is also updated unless autoMargins property is set to false. You can add any number of titles - each of them will be placed in a new line. To remove titles, simply clear titles array: chart.titles = []; and call chart.validateNow() method.

text - text of a title size - font size color - title color alpha - title opacity bold - boolean value indicating if title should be bold.

animateAgain()

Returns void

You can trigger the animation of the pie chart.

clear()

Returns void

Inherited from AmChart

Clears the chart area, intervals, etc.

clearLabels()

Returns void

Inherited from AmChart

Removes all labels added to the chart.

clickSlice(
index
)

Returns void

You can trigger the click on a slice from outside.

index - the number of a slice or Slice object.

hideSlice(
index
)

Returns void

Hides slice.

index - the number of a slice or Slice object.

invalidateSize()

Returns void

Inherited from AmChart

Use this method to force the chart to resize to it's current container size.

removeLegend()

Returns void

Inherited from AmChart

Removes chart's legend.

removeListener(
  chart,
  type,
  handler
)

Returns void

Inherited from AmChart

Removes event listener from chart object.

chart - chart object, type - event name, handler - method

rollOutSlice(
index
)

Returns void

You can simulate roll-out of a slice from outside.

index - the number of a slice or Slice object.

rollOverSlice(
index
)

Returns void

You can simulate roll-over a slice from outside.

index - the number of a slice or Slice object.

showSlice(
index
)

Returns void

Shows slice.

index - the number of a slice or Slice object.

validateData()

Returns void

Inherited from AmChart

This method should be called after data in your data provider changed or a new array was set to dataProvider. After calling this method the chart will parse data and redraw.

validateNow()

Returns void

Inherited from AmChart

This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called.

write(
container
)

Returns void

Inherited from AmChart

Adds chart to the specified DIV.

container - id of a DIV or DIV object which will hold the chart

There are 12 inherited items currently hidden from this list.

Events

#clickSlice	Param `{type:"clickSlice", dataItem:Slice}` Dispatched when user clicks on a slice.
#pullInSlice	Param `{type:"pullInSlice", dataItem:Slice}` Dispatched when user clicks on a slice and the slice is pulled-in.
#pullOutSlice	Param `{type:"pullOutSlice", dataItem:Slice}` Dispatched when user clicks on a slice and the slice is pulled-out.
#rightClickSlice	Param `{type:"rightClickSlice", dataItem:Slice}` Dispatched when user right-clicks the slice.
#rollOutSlice	Param `{type:"rollOutSlice", dataItem:Slice}` Dispatched when user rolls-out of the slice.
#rollOverSlice	Param `{type:"rollOverSlice", dataItem:Slice}` Dispatched when user rolls-over the slice.
#dataUpdated	Param `{type:"dataUpdated", chart:AmChart}` Inherited from `AmChart` Dispatched when chart is build for the first time or after validateData() method was called.
#init	Param `{type:"init", chart:AmChart}` Inherited from `AmChart` Dispatched when chart is build for the first time.
#rendered	Param `{type:"rendered", chart:AmChart}` Inherited from `AmChart` Dispatched when the chart is build for the first time.
There are 3 inherited items currently hidden from this list.

Adapters

AmPieChart does not have any adapters.