jsx3.chart.PieSeriesAPI


Object
Object TypeThe JSX foundation class that this object is an instance of.
IDThe unique, system-assigned ID for this object.
NameSets the name assigned by the developer to identify this object.
Series
Series NameSets the jsxname of the data series displayed in the legend.
By-Category
ColorsSets the colors for this series.
StrokeSets the stroke for this series.
Color FunctionA static function used to color per-category regions in a series.
Label PlacementSets the quadrant to place an optional ChartLabel child that displays the name of the series.
Label OffsetSets the offset of the optional ChartLabel child in pixels.
Component
DisplayUsed to hide this chart component without removing it from the DOM hierarchy.
Interaction
Tooltip FunctionA static function determines what is displayed in the tooltip when the user moves the mouse over a data point, with signature function(series, datum) : String.
Bound MenuSets the jsxname property for the context menu instance to display on a right-click.

Object Type

Read-Only. The JSX foundation class that this object is an instance of.

ID

Read-Only. The unique, system-assigned ID for this object.
Getter: getId()

Name

Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname

Series Name

Sets the jsxname of the data series displayed in the legend.
Getter: getSeriesName()
Setter: setSeriesName()
Property: seriesName

Colors

Sets the colors for this series. Overrides the value in PieChart. Specify as: color1 alpha1, color2 alpha2,...
Default Value: Default color scheme
Getter: getColors()
Setter: setColors()
Property: colors

Stroke

Sets the stroke for this series. Overrides the value in PieChart.
Default Value: Empty
Getter: getStroke()
Setter: setStroke()
Property: stroke

Color Function

A static function used to color per-category regions in a series. The signature of the function is function(record:jsx3.xml.Entity, index:int) : jsx3.vector.Fill.
Getter: getColorFunction()
Setter: setColorFunction()
Property: colorFunction

Label Placement

Sets the quadrant to place an optional ChartLabel child that displays the name of the series.
Default Value: bottom (jsx3.chart.QBOTTOM)
Getter: getLabelPlacement()
Setter: setLabelPlacement()
Property: labelPlacement
Allowed Values:

Label Offset

Sets the offset of the optional ChartLabel child in pixels.
Default Value: 0
Getter: getLabelOffset()
Setter: setLabelOffset()
Property: labelOffset

Display

Used to hide this chart component without removing it from the DOM hierarchy.
Default Value: Block (jsx3.gui.Block.DISPLAYBLOCK)
Getter: getDisplay()
Setter: setDisplay()
Property: jsxdisplay
Allowed Values:

Tooltip Function

A static function determines what is displayed in the tooltip when the user moves the mouse over a data point, with signature function(series, datum) : String. If null, toolitp isn't rendered.
Getter: getTooltipFunction()
Setter: setTooltipFunction()
Property: tooltipFunction

Bound Menu

Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu