jsx3.chart.PieChartAPI
| Object |
|---|
| Object Type | The JSX foundation class that this object is an instance of. |
| ID | The unique, system-assigned ID for this object. |
| Name | Sets the name assigned by the developer to identify this object. |
| Positioning |
|---|
| Left | Sets the distance from left edge of bounding box in pixels. |
| Top | Sets the distance from top edge of bounding box in pixels. |
| Width | Sets the width of the chart in implied pixels or as a percentage. |
| Height | Sets the height of the chart in implied pixels or as a percentage. |
| Relative XY | Sets whether to place this chart relatively or absolutely with respect to its container. |
| PieChart |
|---|
| Inner Radius | Sets the radius of the doughnut hole in the center of this pie chart as a ratio of the chart radius (0.0 - 1.0). |
| Series Padding | Sets the padding between series in this chart, as a multiple of the width of a series. |
| Total Angle | Sets the default total angle for each series (0 - 360). |
| Start Angle | Sets the angle for the start of the first pie slice. |
| By-Category |
|---|
| Category Field | Sets the attribute of the data provider containing the category value. |
| Colors | Sets an array of colors to use to color the pie slices. |
| Series Stroke | Sets the vector stroke to use to outline the slices in each series. |
| Color Function | A static function used to color per-category regions in a series. |
| XML/XSL |
|---|
| XML Cache Id | Sets the cache ID for the XML document this object is mapped to. |
| XML String | Sets an XML document as a string. |
| XML URL | Sets the URL for the resource. |
| XML Transformers | A comma-separated list of XSLT transformers. |
| Share Resources | If set to Share, this object does not delete its associated document from the cache when removed from the DOM. |
| XML Async | If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads. |
| XML Bind | If set to Bound this control automatically repaints every time its XML cache document changes. |
| Background |
|---|
| BG Color | Sets the background color of this component. |
| BG Alpha | Sets the background alpha (opacity) of this component (0.0 - 1.0). |
| Border Color | Sets the border color of this component. |
| Border Width | Sets the border width of this component in pixels. |
| Border Alpha | The border alpha (opacity) of this component (0.0 - 1.0). |
| Misc. Chart |
|---|
| Padding | Sets the white-space gap between outer edge/border of this component to its inner content. |
| Data Area Padding | Sets the white-space gap between data area and its containing box. |
| Title Placement | Sets the direction in which to render the title. |
| Legend Placement | Sets the direction in which to render the legend. |
| Interaction |
|---|
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
Read-Only. The JSX foundation class that this object is an instance of.
Read-Only. The unique, system-assigned ID for this object.
Getter: getId()
Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname
Sets the distance from left edge of bounding box in pixels. Other units not supported.
Default Value: If absolutely positioned, the default is 0. If relatively positioned, the default is empty.
Getter: getLeft()
Setter: setLeft()
Property: jsxleft
Sets the distance from top edge of bounding box in pixels. Other units not supported.
Default Value: If absolutely positioned, the default is 0. If relatively positioned, the default is empty.
Getter: getTop()
Setter: setTop()
Property: jsxtop
Sets the width of the chart in implied pixels or as a percentage. For exmaple, 100 or 25%.
Getter: getWidth()
Setter: setWidth()
Property: jsxwidth
Sets the height of the chart in implied pixels or as a percentage. For exmaple, 100 or 25%.
Getter: getHeight()
Setter: setHeight()
Property: jsxheight
Sets whether to place this chart relatively or absolutely with respect to its container.
Default Value: Relative (jsx3.gui.Block.RELATIVE)
Getter: getRelativePosition()
Setter: setRelativePosition()
Property: jsxrelativeposition
Allowed Values: - Absolute (
jsx3.gui.Block.ABSOLUTE) - Relative (
jsx3.gui.Block.RELATIVE)
Sets the radius of the doughnut hole in the center of this pie chart as a ratio of the chart radius (0.0 - 1.0).
Default Value: 0
Getter: getInnerRadius()
Setter: setInnerRadius()
Property: innerRadius
Sets the padding between series in this chart, as a multiple of the width of a series.
Default Value: 0
Getter: getSeriesPadding()
Setter: setSeriesPadding()
Property: seriesPadding
Sets the default total angle for each series (0 - 360).
Default Value: 360
Getter: getTotalAngle()
Setter: setTotalAngle()
Property: totalAngle
Sets the angle for the start of the first pie slice. Values start at north and continue clockwise (0 - 360).
Default Value: 0
Getter: getStartAngle()
Setter: setStartAngle()
Property: startAngle
Sets the attribute of the data provider containing the category value.
Getter: getCategoryField()
Setter: setCategoryField()
Property: categoryField
Sets an array of colors to use to color the pie slices. Specified as color1 alpha1, color2 alpha 2, .... For example, black 1, red .4.
Default Value: Default color scheme
Getter: getColors()
Setter: setColors()
Property: colors
Sets the vector stroke to use to outline the slices in each series. Specified as color width alpha. For example, black 1 1.
Default Value: Empty
Getter: getSeriesStroke()
Setter: setSeriesStroke()
Property: seriesStroke
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
Sets the cache ID for the XML document this object is mapped to.
Default Value: Unique ID assigned by the system
Getter: getXMLId()
Setter: setXMLId()
Property: jsxxmlid
Sets an XML document as a string.
Getter: getXMLString()
Setter: setXMLString()
Property: jsxxml
Sets the URL for the resource. This resource is synchronously loaded when this object is painted on-screen.
Getter: getXMLURL()
Setter: setXMLURL()
Property: jsxxmlurl
A comma-separated list of XSLT transformers. The source XML will be transformed in series by each of the transformers listed here before being placed in the XML cache. Each transformer is either a URI to an XSLT file or the XML cache id of an XSLT document.
Getter: getXMLTransformers()
Setter: setXMLTransformers()
Property: jsxxmltrans
If set to Share, this object does not delete its associated document from the cache when removed from the DOM.
Default Value: Cleanup (jsx3.xml.Cacheable.CLEANUPRESOURCES)
Getter: getShareResources()
Setter: setShareResources()
Property: jsxshare
Allowed Values: - Cleanup (
jsx3.xml.Cacheable.CLEANUPRESOURCES) - Share (
jsx3.xml.Cacheable.SHARERESOURCES)
If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads.
Default Value: Synchronous (jsx3.Boolean.FALSE)
Getter: getXmlAsync()
Setter: setXmlAsync()
Property: jsxxmlasync
Allowed Values: - Asynchronous (
jsx3.Boolean.TRUE) - Synchronous (
jsx3.Boolean.FALSE)
If set to Bound this control automatically repaints every time its XML cache document changes.
Default Value: Not Bound (jsx3.Boolean.FALSE)
Getter: getXmlBind()
Setter: setXmlBind()
Property: jsxxmlbind
Allowed Values: - Bound (
jsx3.Boolean.TRUE) - Not Bound (
jsx3.Boolean.FALSE)
Sets the background color of this component. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: Empty
Getter: getBackgroundColor()
Setter: setBackgroundColor()
Property: jsxbgcolor
Sets the background alpha (opacity) of this component (0.0 - 1.0).
Default Value: 1
Getter: getAlpha()
Setter: setAlpha()
Property: alpha
Sets the border color of this component. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: No border
Getter: getBorderColor()
Setter: setBorderColor()
Property: borderColor
Sets the border width of this component in pixels.
Default Value: 1
Getter: getBorderWidth()
Setter: setBorderWidth()
Property: borderWidth
The border alpha (opacity) of this component (0.0 - 1.0).
Default Value: 1
Getter: getBorderAlpha()
Setter: setBorderAlpha()
Property: borderAlpha
Sets the white-space gap between outer edge/border of this component to its inner content. Specified as one or four pixel values (top, right, bottom, and left). For example, 5 or 8 4 8 4. CSS syntax is also supported but reduces performance.
Default Value: 0
Getter: getPadding()
Setter: setPadding()
Property: jsxpadding
Sets the white-space gap between data area and its containing box. Specified as one or four pixel values (top, right, bottom, and left). For example, 5 or 8 4 8 4.
Default Value: 0
Getter: getDataPadding()
Setter: setDataPadding()
Property: dataPadding
Sets the direction in which to render the title.
Default Value: top (jsx3.chart.QTOP)
Getter: getTitlePlacement()
Setter: setTitlePlacement()
Property: titlePlacement
Allowed Values: - top (
jsx3.chart.QTOP) - right (
jsx3.chart.QRIGHT) - bottom (
jsx3.chart.QBOTTOM) - left (
jsx3.chart.QLEFT)
Sets the direction in which to render the legend.
Default Value: right (jsx3.chart.QRIGHT)
Getter: getLegendPlacement()
Setter: setLegendPlacement()
Property: legendPlacement
Allowed Values: - top (
jsx3.chart.QTOP) - right (
jsx3.chart.QRIGHT) - bottom (
jsx3.chart.QBOTTOM) - left (
jsx3.chart.QLEFT)
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Copyright © 2001-2007, TIBCO Software Inc.