Main Page | Packages | Class Tree | Index | Help

xp.charting

class PieChart

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.charting.PieChart


class PieChart
extends UIControl

PieChart


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
alphaActive: Number
The alpha value for active slices

public
alphaNormal: Number
The alpha value for non-active slices

public
autoCalcPieSize: Boolean
Determines whether pie radius us automtatically calculated

public
autoDraw: Boolean
Determines whether chart is automatically drawn when the series data is set

public
borderColor: Number
bordercolor of a wedge

public
chartType: String
the default chart type

public static
classInfo: Object
A static class information object

public
colorField: String
The field in the dataProvider that contains the segment color's*

public
datalabelFormatString: String
thre data display %1-label,%2-value,%3-percent

public
datalabelOffset: Number
controls the distance between a datalabel and the pie

public
draw3d: Boolean
Determines whether chart is drawn in 3D when the series data is set

public
dropHeight: Number
The depth of a 3D slice

public
dropShadowColor: Number
The drop shadpow color

public
dropShadowX: Number
The dropshadow offset x

public
dropShadowY: Number
The dropshadow offset y

public
dwellLabelPosition: String
Determines where dwell label will be placed

public
explodeDistActive: Number
The distance the active pie slice is away from the centre of the pie

public
explodeDistNormal: Number
The distance the non active pie slice is away from the centre of the pie

public
format: String
Format string for point labels

public
initialActiveSlice: Number
index of the initial slice to be active

public
insideLabelPosition: Number
The position of the label inside the Pie


isColumnsInit


public
label: MovieClip
the control the we will use to display rollover labels

public
labelField: String
The field in the dataProvider that contains the segment labels*

public
labelFormatString: String
rollover format %1-label,%2-value,%3-percent

public
labelStyle: Object
The style for the point labels

public
legend: MovieClip
the control for displaying the legend

public
legendFormatString: String
legend format %1-label,%2-value,%3-percent


manualInit


public
minPercentage: Number
Specify the minimum point value needed to be included in a particular pie chart

public
othersLabel: String
Specify the minimum point value needed to be included in a particular pie chart

public
percentDecimals: Number
Number of decimal places for percentage display

public
pieRadius: Number
Set the pieRadius, this is ignored if autoCalcPieSize is true

public
ringSize: Number
The size oof the doughnut ring

public
styleClass: String
The name of the style class this instance will use.

public
valueField: String
The field in the dataProvider that contains the segment values*

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
angleX: Number (read, write)
Allows you to set a 3D rotation angle around the X-axis

public
angleY: Number (read, write)
Allows you to set a 3D rotation angle around the Y-axis.

public
dataProvider: Object (read, write)
The source of the chart items.

public
legendPlacement: String (read, write)


Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
PieChart ( )


Method Summary

public
drawChart ( ): Void
draws the chart

public
getClass ( ): Function
Returns a reference to the components static class

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

public
onTweenUpdate ( val, context: Object ): Void


public
setSeries ( dataProvider: Object ): Void
data is an array of objects with fields label and value (and optionally color) (see PieSlieDesc)

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate



Field Documentation

alphaActive

public var alphaActive: Number
The alpha value for active slices

alphaNormal

public var alphaNormal: Number
The alpha value for non-active slices

autoCalcPieSize

public var autoCalcPieSize: Boolean
Determines whether pie radius us automtatically calculated

autoDraw

public var autoDraw: Boolean
Determines whether chart is automatically drawn when the series data is set

borderColor

public var borderColor: Number
bordercolor of a wedge

chartType

public var chartType: String
the default chart type

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

colorField

public var colorField: String
The field in the dataProvider that contains the segment color's*

datalabelFormatString

public var datalabelFormatString: String
thre data display %1-label,%2-value,%3-percent

datalabelOffset

public var datalabelOffset: Number
controls the distance between a datalabel and the pie

draw3d

public var draw3d: Boolean
Determines whether chart is drawn in 3D when the series data is set

dropHeight

public var dropHeight: Number
The depth of a 3D slice

dropShadowColor

public var dropShadowColor: Number
The drop shadpow color

dropShadowX

public var dropShadowX: Number
The dropshadow offset x

dropShadowY

public var dropShadowY: Number
The dropshadow offset y

dwellLabelPosition

public var dwellLabelPosition: String
Determines where dwell label will be placed

When the mouse hovers over a marker a label is displayed. This property controls the placement. One of outside,inside,tooltip,none.

explodeDistActive

public var explodeDistActive: Number
The distance the active pie slice is away from the centre of the pie

explodeDistNormal

public var explodeDistNormal: Number
The distance the non active pie slice is away from the centre of the pie

format

public var format: String
Format string for point labels

initialActiveSlice

public var initialActiveSlice: Number
index of the initial slice to be active

insideLabelPosition

public var insideLabelPosition: Number
The position of the label inside the Pie

The position of the label as a percentage of the radius of the ring

isColumnsInit

var isColumnsInit

label

public var label: MovieClip
the control the we will use to display rollover labels

labelField

public var labelField: String
The field in the dataProvider that contains the segment labels*

labelFormatString

public var labelFormatString: String
rollover format %1-label,%2-value,%3-percent

labelStyle

public var labelStyle: Object
The style for the point labels

legend

public var legend: MovieClip
the control for displaying the legend

legendFormatString

public var legendFormatString: String
legend format %1-label,%2-value,%3-percent

manualInit

var manualInit

minPercentage

public var minPercentage: Number
Specify the minimum point value needed to be included in a particular pie chart

othersLabel

public var othersLabel: String
Specify the minimum point value needed to be included in a particular pie chart

percentDecimals

public var percentDecimals: Number
Number of decimal places for percentage display

pieRadius

public var pieRadius: Number
Set the pieRadius, this is ignored if autoCalcPieSize is true

ringSize

public var ringSize: Number
The size oof the doughnut ring

The width of the doughnut ring as a percentage of the radius of the ring

styleClass

public var styleClass: String
The name of the style class this instance will use.

valueField

public var valueField: String
The field in the dataProvider that contains the segment values*


Property Documentation

angleX

public angleX: Number (read, write)
Allows you to set a 3D rotation angle around the X-axis

The value can be set to an integer between [0-90] indicating the degree of rotation around the X-axis. Currently this must be 0

angleY

public angleY: Number (read, write)
Allows you to set a 3D rotation angle around the Y-axis.

The value can be set to an integer between [0-90] indicating the degree of rotation around the Y-axis.

dataProvider

public dataProvider: Object (read, write)
The source of the chart items.

The data model for items viewed in a chart. The value of this property can be an array or any object that implements the DataProvider API.

legendPlacement

public legendPlacement: String (read, write)

Constructor Documentation

PieChart

public function PieChart()

Method Documentation

drawChart

public function drawChart(): Void
draws the chart

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:

newInstance

public static function newInstance(owner,
 instanceId,
 depth,
 initObj)
Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:
owner
A reference to the movie clip or object that will contains the new Instance.
instanceId
A string indicating the instance name of the new instance.(optional)
depth
A number indicating the depth of the new instance.(optional)
initObj
An object containing initialization properties for the new instance.(optional)
Returns:
A object that is an instance of the specified class.

onTweenUpdate

public function onTweenUpdate(val,
 context: Object): Void

setSeries

public function setSeries(dataProvider: Object): Void
data is an array of objects with fields label and value (and optionally color) (see PieSlieDesc)


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc