Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • _AmPieChart
    • AmPieChart

Index

Constructors

constructor

  • used when constructing a chart with a theme

    Parameters

    • Optional theme: any

    Returns AmPieChart

Properties

addClassNames

addClassNames: boolean

Specifies, if class names should be added to chart elements.

allLabels

allLabels: default[]

Array of Labels. Example of label object, with all possible properties: { "x": 20, "y": 20, "text": "this is label", "align": "left", "size": 12, "color": "#CC0000", "alpha": 1, "rotation": 0, "bold": true, "url": "http://www.amcharts.com" }

alphaField

alphaField: string

Name of the field in chart's dataProvider which holds slice's alpha.

angle

angle: number

Pie lean angle (for 3D effect). Valid range is 0 - 90.

autoResize

autoResize: boolean

Set this to false if you don't want chart to resize itself whenever its parent container size changes.

backgroundAlpha

backgroundAlpha: number

Opacity of background. Set it to >0 value if you want backgroundColor to work. However we recommend changing div's background-color style for changing background color.

backgroundColor

backgroundColor: string

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.

default

"#FFFFFF"

balloon

balloon: default

The chart creates AmBalloon class itself. If you want to customize balloon, get balloon instance using this property, and then change balloon's properties.

balloonText

balloonText: string

Balloon text. The following tags can be used: [[value]], title, percents, description. title: percents% ([[value]])\ndescription

borderAlpha

borderAlpha: number

Opacity of chart's border. Value range is 0 - 1.

borderColor

borderColor: string

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.

default

#000000

chartData

chartData: any[]

Read-only. Array of Slice objects.

classNamePrefix

classNamePrefix: string

This prefix is added to all class names which are added to all visual elements of a chart in case addClassNames is set to true.

color

color: string

Text color. #000000

colorField

colorField: string

Name of the field in chart's dataProvider which holds slice's color.

colors

colors: any[]

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. [ "#FF0F00", "#FF6600", "#FF9E01", "#FCD202", "#F8FF01", "#B0DE09", "#04D215", "#0D8ECF", "#0D52D1", "#2A0CD0", "#8A0CCF", "#CD0D74", "#754DEB", "#DDDDDD", "#999999", "#333333", "#000000", "#57032A", "#CA9726", "#990000", "#4B0C25" ]

creditsPosition

creditsPosition: string

Non-commercial version only. Specifies position of link to amCharts site. Allowed values are: top-left, top-right, bottom-left and bottom-right.

default

'top-left'

dataProvider

dataProvider: any[]

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.

decimalSeparator

decimalSeparator: string

Decimal separator.

default

"."

defs

defs: any

Using this property you can add any additional information to SVG, like SVG filters or clip paths. The structure of this object should be identical to XML structure of a object you are adding, only in JSON format.

depth3D

depth3D: number

Depth of the pie (for 3D effect).

descriptionField

descriptionField: string

Name of the field in chart's dataProvider which holds a string with description.

export

export: default

Export config. Specifies how export to image/data export/print/annotate menu will look and behave. You can find a lot of examples in amcharts/plugins/export folder.

fontFamily

fontFamily: string

Font family. Verdana

fontSize

fontSize: string

Font size.

default

11

gradientRatio

gradientRatio: number[]

Example: [-0.2,0.2]. Will make slices to be filled with color gradients.

groupPercent

groupPercent: number

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.

groupedAlpha

groupedAlpha: number

Opacity of the group slice. Value range is 0 - 1.

default

1

groupedColor

groupedColor: string

Color of the group slice. The default value is not set - this means the next available color from "colors" array will be used.

groupedDescription

groupedDescription: string

Description of the group slice.

groupedPulled

groupedPulled: boolean

If this is set to true, the group slice will be pulled out when the chart loads.

groupedTitle

groupedTitle: string

Title of the group slice. Other

handDrawScatter

handDrawScatter: number

Defines by how many pixels hand-drawn line (when handDrawn is set to true) will fluctuate.

default

2

handDrawThickness

handDrawThickness: number

Defines by how many pixels line thickness will fluctuate (when handDrawn is set to true).

default

1

handDrawn

handDrawn: boolean

If you set this to true, the lines of the chart will be distorted and will produce hand-drawn effect. Try to adjust chart.handDrawScatter and chart.handDrawThickness properties for a more scattered result.

default

false

hideBalloonTime

hideBalloonTime: number

Time, in milliseconds after which balloon is hidden if the user rolls-out of the object. Might be useful for AmMap to avoid balloon flickering while moving mouse over the areas. Note, this is not duration of fade-out. Duration of fade-out is set in AmBalloon class.

default

150

hideLabelsPercent

hideLabelsPercent: number

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

hoverAlpha: number

Opacity of a hovered slice. Value range is 0 - 1.

default

1

innerRadius

innerRadius: any

Inner radius of the pie, in pixels or percents.

labelRadius

labelRadius: number

The distance between the label and the slice, in pixels. You can use negative values to put the label on the slice.

default

30

labelRadiusField

labelRadiusField: 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.

labelText

labelText: string

Label text. The following tags can be used: [[value]], title, percents, description. title: percents%

labelTickAlpha

labelTickAlpha: number

Label tick opacity. Value range is 0 - 1. 0.2

labelTickColor

labelTickColor: string

Label tick color. #000000

labelsEnabled

labelsEnabled: boolean

Specifies whether data labels are visible.

default

true

legend

legend: default

Legend of a chart.

legendDiv

legendDiv: HTMLElement

Reference to the div of the legend.

listerns

listerns: object[]

You can add listeners of events using this property. Example: listeners = [{"event":"dataUpdated", "method":handleEvent}];

marginBottom

marginBottom: number

Bottom margin of the chart.

default

5

marginLeft

marginLeft: number

Left margin of the chart.

marginRight

marginRight: number

Right margin of the chart.

marginTop

marginTop: number

Top margin of the chart.

default

5

minRadius

minRadius: number

Minimum radius of the pie, in pixels.

default

10

outlineAlpha

outlineAlpha: number

Pie outline opacity. Value range is 0 - 1.

outlineColor

outlineColor: string

Pie outline color. #FFFFFF

outlineThickness

outlineThickness: number

Pie outline thickness.

default

1

panEventsEnabled

panEventsEnabled: boolean

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.

path

path: string

Specifies absolute or relative path to amCharts files, i.e. "amcharts/". (where all .js files are located) If relative URLs are used, they will be relative to the current web page, displaying the chart. You can also set path globally, using global JavaScript variable AmCharts_path. If this variable is set, and "path" is not set in chart config, the chart will assume the path from the global variable. This allows setting amCharts path globally. I.e.: let AmCharts_path = "/libs/amcharts/"; "path" parameter will be used by the charts to locate it's files, like images, plugins or patterns.

pathToImages

pathToImages: string

Specifies path to the folder where images like resize grips, lens and similar are. IMPORTANT: Since V3.14.12, you should use "path" to point to amCharts directory instead. The "pathToImages" will be automatically set and does not need to be in the chart config, unless you keep your images separately from other amCharts files.

percentPrecision

percentPrecision: number

Precision of percent values. -1 means percent values won't be rounded at all and show as they are.

default

2

pieAlpha

pieAlpha: number

Opacity of the slices. You can set the opacity of individual slice too.

default

1

pieBaseColor

pieBaseColor: string

Color of the first slice. All the other will be colored with darker or brighter colors.

pieBrightnessStep

pieBrightnessStep: number

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.

default

30

pieX

pieX: any

You can set fixed position of a pie center, in pixels or in percents.

pieY

pieY: any

You can set fixed position of a pie center, in pixels or in percents.

precision

precision: number

Precision of values. -1 means values won't be rounded at all and show as they are.

default

1

prefixesOfBigNumbers

prefixesOfBigNumbers: any[]

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. [ {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"} ]

prefixesOfSmallNumbers

prefixesOfSmallNumbers: any[]

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. [ {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"} ]

pullOutDuration

pullOutDuration: number

Pull out duration, in seconds.

default

1

pullOutEffect

pullOutEffect: string

Pull out effect. Possible values are ">", "<", elastic" and "bounce". bounce

pullOutOnlyOne

pullOutOnlyOne: boolean

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

pullOutRadius: any

Pull out radius, in pixels or percents 0.2

pulledField

pulledField: 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.

radius

radius: any

Radius of a pie, in pixels or percents. By default, radius is calculated automatically.

sequencedAnimation

sequencedAnimation: boolean

Specifies whether the animation should be sequenced or all slices should appear at once.

startAlpha

startAlpha: number

Initial opacity of all slices. If you set startDuration higher than 0, slices will fade in from startAlpha.

default

1

startAngle

startAngle: number

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.

default

90

startDuration

startDuration: number

Duration of the animation, in seconds.

default

1

startEffect

startEffect: string

Animation effect. Possible values are ">", "<", "elastic" and "bounce". bounce

startRadius

startRadius: any

Radius of the positions from which the slices will fly in.

default

5

theme

theme: string

Theme of a chart. Config files of themes can be found in amcharts/themes/ folder. More info about using themes.

thousandsSeparator

thousandsSeparator: string

Thousands separator.

default

"."

titleField

titleField: string

Name of the field in chart's dataProvider which holds slice's title.

titles

titles: default[]

Array of Title objects.

type

type: string

Type of a chart. Required when creating chart using JSON. Possible types are: serial, pie, xy, radar, funnel, gauge, map, stock.

urlField

urlField: string

Name of the field in chart's dataProvider which holds url which would be accessed if the user clicks on a slice.

urlTarget

urlTarget: string

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. _self

usePrefixes

usePrefixes: boolean

If true, prefixes will be used for big and small numbers. You can set arrays of prefixes via prefixesOfSmallNumbers and prefixesOfBigNumbers properties.

valueField

valueField: string

Name of the field in chart's dataProvider which holds slice's value.

version

version: string

Read-only. Indicates current version of a script.

visibleInLegendField

visibleInLegendField: 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.

Methods

addLabel

  • addLabel(x: string | number, y: string | number, text: string, align: string, size?: number, color?: string, rotation?: number, alpha?: number, bold?: boolean, url?: string): any
  • 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

    Parameters

    • x: string | number
    • y: string | number
    • text: string
    • align: string
    • Optional size: number
    • Optional color: string
    • Optional rotation: number
    • Optional alpha: number
    • Optional bold: boolean
    • Optional url: string

    Returns any

addLegend

  • addLegend(legend: default, legendDivId?: string): void
  • addLegend(legend: default, legendDiv: HTMLElement): void
  • 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.)

    Parameters

    • legend: default

      The legend.

    • Optional legendDivId: string

      Id of the legend div (optional).

    Returns void

  • 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.)

    Parameters

    • legend: default

      The legend.

    • legendDiv: HTMLElement

      Legend div (optional).

    Returns void

addListener

  • addListener(type: string, handler: (e: { chart: default; dataItem: default; type: string }) => void): void
  • Adds event listener of the type "clickSlice" or "pullInSlice" or "pullOutSlice" to the object.

    Parameters

    • type: string

      Always "clickSlice" or "pullInSlice" or "pullOutSlice".

    • handler: (e: { chart: default; dataItem: default; type: string }) => void

      If the type is "clickSlice", dispatched when user clicks on a slice. If the type is "pullInSlice", dispatched when user clicks on a slice and the slice is pulled-in. If the type is "pullOutSlice", dispatched when user clicks on a slice and the slice is pulled-out. If the type is "rollOutSlice", dispatched when user rolls-out of the slice. If the type is "rollOverSlice", dispatched when user rolls-over the slice.

        • (e: { chart: default; dataItem: default; type: string }): void
        • Parameters

          • e: { chart: default; dataItem: default; type: string }
            • chart: default
            • dataItem: default
            • type: string

          Returns void

    Returns void

addTitle

  • addTitle(text: string, size: number, color: string, alpha: number, bold: boolean): void
  • 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.

    Parameters

    • text: string
    • size: number
    • color: string
    • alpha: number
    • bold: boolean

    Returns void

animateAgain

  • animateAgain(): void
  • You can trigger the animation of the pie chart.

    Returns void

clear

  • clear(): void
  • Clears the chart area, intervals, etc.

    Returns void

clearLabels

  • clearLabels(): void
  • Removes all labels added to the chart.

    Returns void

clickSlice

  • clickSlice(index: number): void
  • You can trigger the click on a slice from outside. index - the number of a slice or Slice object.

    Parameters

    • index: number

    Returns void

hideSlice

  • hideSlice(index: number): void
  • Hides slice. index - the number of a slice or Slice object.

    Parameters

    • index: number

    Returns void

invalidateSize

  • invalidateSize(): void
  • Use this method to force the chart to resize to it's current container size.

    Returns void

removeLegend

  • removeLegend(): void
  • Removes chart's legend.

    Returns void

removeListener

  • removeListener(chart: default, type: string, handler: any): void
  • Removes event listener from chart object.

    Parameters

    • chart: default
    • type: string
    • handler: any

    Returns void

rollOutSlice

  • rollOutSlice(index: number): void
  • You can simulate roll-out of a slice from outside. index - the number of a slice or Slice object.

    Parameters

    • index: number

    Returns void

rollOverSlice

  • rollOverSlice(index: number): void
  • You can simulate roll-over a slice from outside. index - the number of a slice or Slice object.

    Parameters

    • index: number

    Returns void

showSlice

  • showSlice(index: number): void
  • Shows slice. index - the number of a slice or Slice object.

    Parameters

    • index: number

    Returns void

validateData

  • validateData(): void
  • 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.

    Returns void

validateNow

  • validateNow(): void
  • This method should be called after you changed one or more properties of any class. The chart will redraw after this method is called.

    Returns void

write

  • write(container: string | HTMLDivElement): void
  • Adds chart to the specified DIV.

    Parameters

    • container: string | HTMLDivElement

    Returns void

Generated using TypeDoc