(Preview)
| Package | mx.charts.chartClasses |
| Class | public class ChartBase |
| Inheritance | ChartBase  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IFocusManagerComponent |
| Subclasses | CartesianChart, PolarChart |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
You typically do not use the ChartBase class directly. Instead you use one of its subclasses, such as PlotChart or BubbleChart. It acts as the base class for the common chart types provided in the mx.charts package.
This class defines a number of CSS styles and properties that provide easy access to the more common features of the framework.
A chart's minimum size is 20 x 20 pixels. A chart's maximum size is unbounded. A chart's preferred size is 400 x 400 pixels.
ChartBase objects, and its subclasses, augment the normal
mouse event objects with additional data that describes
the nearest chart data point under the mouse.
The event object for mouse events contains an additional property,
hitData, which contains a HitData object
that describes the nearest data point.
See mx.charts.HitData for more information on the contents
of the HitData object.
ChartBase objects consider data points only within a certain radius
of the mouse pointer.
You can set this radius using the mouseSensitivity
property.
If there is no data point within the mouseSensitivity
radius, event.hitData is null.
Show MXML Syntax
Hide MXML SyntaxFlex components inherit the following properties from the ChartBase class:
<mx:tagname
Properties
allElements="Array; No default"
annotationElements="Array; No default"
backgroundElements="Array; No default"
chartState=""
clipContent="false|true"
dataProvider="No default"
dataRegion"No default"
dataTipFunction="No default"
dataTipLayerIndex"No default"
dataTipMode"No default"
description"No default"
dragEnabled="false|true"
dragMoveEnabled="false|true"
dropEnabled="false|true"
labelElements"No default"
legendData"No default"
mouseSensitivity="5"
selectedChartItem=ChartItem; No default"
selectedChartItems=Array; No default"
selectionMode="none|single|multiple"
series="No default"
seriesFilters"No default"
showAllDataTips="true|false"
showDataTips="true|false"
transforms="No default"
Styles
chartSeriesStyles="Style; No default"
dataTipCalloutStroke="Stroke; No default"
dataTipRenderer="Renderer; No default"
fill="IFill; No default"
fontFamily="Verdana"
fontSize="10"
itemDisabledColor="uint; No default"
itemRollOverColor="uint; No default"
itemSelectionColor="uint; No default"
maximumDataTipCount="NaN"
paddingBottom="No default"
paddingTop="No default"
paddingLeft="0"
paddingRight="0"
showDataTipTargets="true|false"
Events
change="Event; No default"
itemClick="Event; No default"
itemDoubleClick="Event; No default"
itemMouseDown="Event; No default"
itemMouseMove="Event; No default"
itemMouseUp="Event; No default"
itemRollOut="Event; No default"
itemRollOver="Event; No default"
>
Default MXML PropertydataProvider
More examples
Using the charting controls
Creating charts in ActionScript
Applying chart styles
Improving charting component performance
Creating charts in ActionScript
Applying chart styles
Improving charting component performance
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| annotationElements : Array
Sets an array of ChartElement objects that appears on top
of any data series rendered by the chart. | ChartBase | ||
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| backgroundElements : Array
Sets an array of background ChartElement objects that appear below
any data series rendered by the chart. | ChartBase | ||
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| chartState : uint [read-only]
The current transition state of the chart. | ChartBase | ||
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| clipContent : Boolean
Determines whether Flex clips the chart to the area bounded by the axes. | ChartBase | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| dataProvider : Object
Specifies the data provider for the chart. | ChartBase | ||
| dataTipFunction : Function
Specifies a callback method used to generate data tips from values. | ChartBase | ||
| dataTipMode : String
Specifies how Flex displays DataTip controls for the chart. | ChartBase | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| description : String
A short description of the data in the chart. | ChartBase | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
Specifies whether you can drag items out of
this chart and drop them on other controls. | ChartBase | ||
| dragMoveEnabled : Boolean
Indicates which display cursor to show as drag feedback. | ChartBase | ||
| dropEnabled : Boolean
A flag that specifies whether dragged items can be dropped onto the
chart. | ChartBase | ||
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| legendData : Array [read-only]
An array of Legend items. | ChartBase | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory [override]
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | ChartBase | ||
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseSensitivity : Number = 5
Specifies the distance, in pixels, that Flex considers a data point
to be under the mouse pointer when the pointer moves around a chart. | ChartBase | ||
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| selectedChartItem : ChartItem [read-only]
Specifies the selected ChartItem in the chart. | ChartBase | ||
| selectedChartItems : Array [read-only]
Specifies an array of all the selected ChartItem objects in the chart. | ChartBase | ||
| selectionMode : String
Specifies whether or not ChartItem objects can be selected. | ChartBase | ||
| series : Array
An array of Series objects that define the chart data. | ChartBase | ||
| seriesFilters : Array
An array of filters that are applied to all series in the chart. | ChartBase | ||
| showAllDataTips : Boolean
Specifies whether Flex shows all DataTip controls for the chart. | ChartBase | ||
| showDataTips : Boolean
Specifies whether Flex shows DataTip controls for the chart. | ChartBase | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| allElements : Array
The set of all chart elements displayed in the chart. | ChartBase | ||
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| dataRegion : Rectangle [read-only]
The area of the chart used to display data. | ChartBase | ||
| dataTipLayerIndex : int [read-only]
The index of the child that is responsible for rendering data tips. | ChartBase | ||
| dragImage : IUIComponent [read-only]
Gets an instance of a class that displays the visuals
during a drag-and-drop operation. | ChartBase | ||
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| labelElements : Array
The set of display objects that represent the labels
for the chart elements. | ChartBase | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ChartBase | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later. | UIComponent | |
Deselects all selected chart items in the chart control. | ChartBase | ||
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
The default handler for the dragStart event. | ChartBase | ||
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
Returns an array of HitData objects that describe
the nearest data point to the coordinates passed to the method. | ChartBase | ||
|
Called after printing is complete. | UIComponent | |
Returns an array of HitData objects representing the chart items
in the underlying objects that implement the IChartElement2 interface. | ChartBase | ||
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
Gets the first item in the chart, with respect to the axes. | ChartBase | ||
|
Gets the object that currently has focus. | UIComponent | |
Gets all the chart items that are within the defined rectangular region. | ChartBase | ||
Gets the last chart item in the chart, with respect to the axes. | ChartBase | ||
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
Gets the chart item next to the currently focused item in the chart,
with respect to the axes. | ChartBase | ||
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
Gets the chart item that is before the currently focused item in the chart,
with respect to the axes. | ChartBase | ||
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
Informs the chart that the underlying data displayed in the chart
has been changed. | ChartBase | ||
Hides the drop indicator that indicates that a
drag-and-drop operation is allowed. | ChartBase | ||
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
Triggers a redraw of the chart. | ChartBase | ||
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Dispatches a new LegendDataChanged event. | ChartBase | ||
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
[override]
Sets the height and width of this object. | ChartBase | ||
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
Displays a drop indicator under the mouse pointer to indicate that a
drag-and-drop operation is allowed. | ChartBase | ||
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
Displays all noninteractive data tips
if showAllDataTips is set. | ChartBase | ||
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
Adds the selected items to the DragSource object as part of a
drag and drop operation. | ChartBase | ||
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
Preprocesses the series and transform for display. | ChartBase | ||
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Processes the properties set on the component. | UIComponent | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
Applies per-series customization and formatting to the series of the chart. | ChartBase | ||
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
Handles events of type DragEvent.DRAG_COMPLETE. | ChartBase | ||
Handles events of type DragEvent.DRAG_DROP. | ChartBase | ||
Handles events of type DragEvent.DRAG_ENTER. | ChartBase | ||
Handles events of type DragEvent.DRAG_EXIT. | ChartBase | ||
Handles events of type DragEvent.DRAG_OVER. | ChartBase | ||
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
Informs the chart that its child list was modified and should be reordererd. | ChartBase | ||
Triggers a redraw of the chart. | ChartBase | ||
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
Informs the chart that its series array was modified and
should be reprocessed. | ChartBase | ||
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
Defines the locations of DataTip objects on the chart when the
showAllDataTips property is set to true. | ChartBase | ||
Defines the locations of DataTip objects on the chart. | ChartBase | ||
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Draws the object and/or sizes and positions its children. | UIComponent | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the selection changes in the chart. | ChartBase | |||
| Dispatched when no data point is found under the mouse pointer when mouse is clicked on chart. | ChartBase | |||
| Dispatched when no data point is found under the mouse pointer when mouse is double-clicked on chart. | ChartBase | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when a data point is found under the mouse pointer when it is clicked. | ChartBase | |||
| Dispatched when a data point is found under the mouse pointer when it is double clicked. | ChartBase | |||
| Dispatched when a data point is found under the mouse pointer when it is pressed down. | ChartBase | |||
| Dispatched when the mouse pointer moves while over a data point. | ChartBase | |||
| Dispatched when a data point is found under the mouse pointer when it is released. | ChartBase | |||
| Dispatched when the closest data point under the mouse pointer changes. | ChartBase | |||
| Dispatched when a new data point is found under the mouse pointer. | ChartBase | |||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
chartSeriesStyles | Type: Array CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Contains a list of Strings, each corresponding to a CSS type selector to be used as the default CSS style for a series. Each series in the chart draws a CSS type selector from the list contained in the chartSeriesStyles style.
The first series uses the first selector, the second uses
the second, and so on.
Style properties in this type selector can be overridden
by specifying a styleName property for the series.
| ChartBase | ||
color | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label. The default value is 0x0B333C. | ChartBase | ||
dataTipCalloutStroke | Type: mx.graphics.IStroke CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The Stroke to use to render the callout line from the data tip target to the tip. If set to null, no Stroke is drawn
| ChartBase | ||
dataTipRenderer | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the class to use to render data tips. This class must implement the IFlexDisplayObject and IDataRenderer interfaces. The chart assigns the custom data tip's data property
to be the HitData structure describing the data point being described.
| ChartBase | ||
disabledColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled. The default value is 0xAAB3B3. | ChartBase | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | ||
fill | Type: mx.graphics.IFill CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the fill style used for the chart background. The fill can be either a simple color value or an object that implements the mx.graphics.IFill interface. | ChartBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
fontAntiAliasType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL)
and "advanced" (flash.text.AntiAliasType.ADVANCED).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is "advanced".Related API Elements | ChartBase | ||
fontFamily | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | ChartBase | ||
fontGridFitType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE),
"pixel" (flash.text.GridFitType.PIXEL),
and "subpixel" (flash.text.GridFitType.SUBPIXEL).
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is "pixel".Related API Elements | ChartBase | ||
fontSharpness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0.Related API Elements | ChartBase | ||
fontSize | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | ChartBase | ||
fontStyle | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | ChartBase | ||
fontThickness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded FlashType font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0.Related API Elements | ChartBase | ||
fontWeight | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface. Recognized values are "normal" and "bold".
For LegendItem, the default is "bold".
The default value is "normal". | ChartBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | ||
itemDisabledColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of disabled chartitem in the chart. | ChartBase | ||
itemRollOverColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of rolledOver chartitem in the chart. | ChartBase | ||
itemSelectionColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of selected chartitem in the chart. | ChartBase | ||
kerning | Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled ( true) or disabled (false).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded FlashType fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false. | ChartBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
letterSpacing | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | ChartBase | ||
maximumDataTipCount | Type: int CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the maximum number of datatips a chart will show. If more datapoints are in range of the chart than allowed by this style, they will be prioritized by distance, with the closest showing first. The default value is NaN, which shows whatever datatips are within range. | ChartBase | ||
paddingBottom | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the number of pixels between the chart's bottom border and its content area. | ChartBase | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the control's left border and the left edge of its content area. The default value is 2. | ChartBase | ||
paddingRight | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the control's right border and the right edge of its content area. The default value is 0. | ChartBase | ||
paddingTop | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the number of pixels between the chart's top border and its content area. | ChartBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
showDataTipTargets | Type: Boolean CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies whether to show targets over the datapoints when showDataTips is set to true.
| ChartBase | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
textAlign | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container. Possible values are "left", "right",
or "center".
The default value for most controls is | ChartBase | ||
textDecoration | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | ChartBase | ||
textIndent | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. The default value is 0. | ChartBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
Spark Theme Styles
Halo Theme Styles
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| HORIZONTAL : String = "horizontal" [static]
The value of this constant is passed to methods such as getNextItem() and getPrevItem(). | ChartBase | ||
| VERTICAL : String = "vertical" [static]
The value of this constant is passed to methods such as getNextItem() and getPrevItem(). | ChartBase | ||
Property Detail
allElements | property |
protected var allElements:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of all chart elements displayed in the chart. This set includes series, second series, background elements, and annotation elements.
annotationElements | property |
annotationElements:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets an array of ChartElement objects that appears on top of any data series rendered by the chart. Each item in the array must extend the mx.charts.DualStyleObject class and implement the IChartElement2 interface.
Implementation
public function get annotationElements():Array public function set annotationElements(value:Array):voidbackgroundElements | property |
backgroundElements:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets an array of background ChartElement objects that appear below any data series rendered by the chart. Each item in the Array must extend the mx.charts.DualStyleObject class and implement the IChartElement2 interface.
Implementation
public function get backgroundElements():Array public function set backgroundElements(value:Array):voidchartState | property |
chartState:uint [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The current transition state of the chart. Use this property to determine whether the chart is currently transitioning out its old data, transitioning in its new data, or has completed all transitions and is showing its current data set. See the mx.charts.chartClasses.ChartState enumeration for possible values.
Implementation
public function get chartState():uintclipContent | property |
clipContent:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether Flex clips the chart to the area bounded by the axes.
Set to false to clip the chart.
Set to true to avoid clipping when the data is rendered.
Implementation
public function get clipContent():Boolean public function set clipContent(value:Boolean):voiddataProvider | property |
dataProvider:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the data provider for the chart.
Data series rendered by the chart are assigned this data provider.
To render disparate data series in the same chart,
use the dataProvider property on the individual series.
This property can accept an array or any other object that implements the IList or ICollectionView interface.
Implementation
public function get dataProvider():Object public function set dataProvider(value:Object):voiddataRegion | property |
dataRegion:Rectangle [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The area of the chart used to display data. This rectangle excludes the area used for gutters, axis lines and labels, and padding.
Implementation
protected function get dataRegion():RectangledataTipFunction | property |
public var dataTipFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a callback method used to generate data tips from values. This method should use the following signature:
function dataTipFunction(hitData:HitData):String
This method returns a string that is displayed for each data point. The text can include HTML formatting. The single parameter is a HitData object that describes the data point.
dataTipLayerIndex | property |
dataTipLayerIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of the child that is responsible for rendering data tips. Derived classes that add visual elements to the chart should add them below this layer.
Implementation
protected function get dataTipLayerIndex():intdataTipMode | property |
dataTipMode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies how Flex displays DataTip controls for the chart. DataTip controls are similar to ToolTip controls, except that they display an appropriate value that represents the nearest chart data point under the mouse pointer.
Possible values of dataTipMode are:
"single"- Data tips are shown for the closest data point to the mouse cursor."multiple"- Data tips are shown for any DataTip control within range of the mouse cursor. You can control the sensitivity with themouseSensitivityproperty.
You can customize DataTip controls with the
dataTipFunction property.
Implementation
public function get dataTipMode():String public function set dataTipMode(value:String):voiddescription | property |
description:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A short description of the data in the chart. When accessibility is enabled, screen readers use this property to describe the chart.
This string defaults to the empty string, and must be explicitly assigned by the developer to have meaning.
Implementation
public function get description():String public function set description(value:String):voiddragEnabled | property |
dragEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether you can drag items out of
this chart and drop them on other controls.
If true, dragging is enabled for the chart.
If the dropEnabled property is also true,
you can drag items and drop them in the chart
to reorder the items.
The default value is false.
Implementation
public function get dragEnabled():Boolean public function set dragEnabled(value:Boolean):voiddragImage | property |
dragImage:IUIComponent [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets an instance of a class that displays the visuals during a drag-and-drop operation.
The default value is mx.controls.chartClasses.ChartItemDragProxy.
Implementation
protected function get dragImage():IUIComponentdragMoveEnabled | property |
dragMoveEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates which display cursor to show as drag feedback.
If true, and the dragEnabled property
is true and the Control key is not held down,
moveCursor is shown as feedback.
If the Control key is held down, copyCursor is shown.
If false and the dragEnabled property
is true, then copyCursor is shown
whether the Control key is held down or not.
The default value is false.
Implementation
public function get dragMoveEnabled():Boolean public function set dragMoveEnabled(value:Boolean):voiddropEnabled | property |
dropEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that specifies whether dragged items can be dropped onto the chart.
If you set this property to true,
the chart accepts all data formats, and assumes that
the dragged data matches the format of the data in the data provider.
To explicitly check the data format of the data
being dragged, you must handle one or more of the drag events,
such as dragOver, and call the
preventDefault() method of the DragEvent to customize
the way the list class accepts dropped data.
When dropEnabled is set to true,
Flex automatically calls the showDropFeedback()
and hideDropFeedback() methods to display the drop indicator.
The default value is false.
Implementation
public function get dropEnabled():Boolean public function set dropEnabled(value:Boolean):voidlabelElements | property |
protected var labelElements:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The set of display objects that represent the labels
for the chart elements.
Some series, annotation, and background types include overlays
such elements and callouts.
Elements can pass a display object to the chart that contains
the overlays to be placed on top of all other chart elememnts.
Chart implementors can access these overlay objects
in the labelElements array.
legendData | property |
legendData:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of Legend items.
This property can be used as the source for data binding. When this property is modified, it dispatches the legendDataChanged event.
Implementation
public function get legendData():ArraymoduleFactory | property |
moduleFactory:IFlexModuleFactory[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
Implementation
override public function get moduleFactory():IFlexModuleFactory override public function set moduleFactory(value:IFlexModuleFactory):voidmouseSensitivity | property |
public var mouseSensitivity:Number = 5| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the distance, in pixels, that Flex considers a data point
to be under the mouse pointer when the pointer moves around a chart.
Flex considers any data point less than mouseSensitivity
pixels away to be under the mouse pointer.
This value is also used by the findDataPoints method.
The default value is 5.
selectedChartItem | property |
selectedChartItem:ChartItem [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the selected ChartItem in the chart. If multiple items are selected, this property specifies the most recently selected item.
Implementation
public function get selectedChartItem():ChartItemselectedChartItems | property |
selectionMode | property |
selectionMode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether or not ChartItem objects can be selected. Possible
values are none, single, or multiple.
Set to none to prevent chart items from being selected.
Set to single to allow only one item to be selected at a time.
Set to multiple to allow one or more chart items to be selected at a time.
The default value is none.
Implementation
public function get selectionMode():String public function set selectionMode(value:String):voidRelated API Elements
series | property |
series:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of Series objects that define the chart data. Each chart defines the type of Series objects that you use to populate this array. For example, a ColumnChart control expects ColumnSeries objects as part of this array. Some charts accept any object of type IChartElement2 as part of the array, but in general each chart expects a specific type.
Implementation
public function get series():Array public function set series(value:Array):voidseriesFilters | property |
seriesFilters:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of filters that are applied to all series in the chart.
Assign an array of bitmap filters to this property to apply them to all the series at once.
Set the seriesFilter property to an empty array to clear the default
filters on the chart's series.
Assigning filters to the seriesFilters property, which applies to all
series, is more efficient than assigning them to individual series.
Implementation
public function get seriesFilters():Array public function set seriesFilters(value:Array):voidshowAllDataTips | property |
showAllDataTips:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether Flex shows all DataTip controls for the chart. DataTip controls are similar to tool tips, except that they display an appropriate value representing the chart data point.
Different chart elements might show different styles of DataTip controls. For example, a stacked chart element might show both the values of the column and the percentage that it contributes to the whole.
You can customize DataTip controls with the
dataTipFunction property.
Implementation
public function get showAllDataTips():Boolean public function set showAllDataTips(value:Boolean):voidshowDataTips | property |
showDataTips:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether Flex shows DataTip controls for the chart. DataTip controls are similar to tool tips, except that they display an appropriate value that represents the nearest chart data point under the mouse pointer.
Different chart elements might show different styles of DataTip controls. For example, a stacked chart element might show both the values of the column and the percentage that it contributes to the whole.
You can customize DataTip controls with the
dataTipFunction property.
Implementation
public function get showDataTips():Boolean public function set showDataTips(value:Boolean):voidConstructor Detail
ChartBase | () | Constructor |
public function ChartBase()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
addDragData | () | method |
protected function addDragData(ds:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds the selected items to the DragSource object as part of a drag and drop operation. You can override this method to add other data to the drag source.
Parameters
ds:Object — The DragSource object to which the data is added.
|
applySeriesSet | () | method |
protected function applySeriesSet(seriesSet:Array, transform:mx.charts.chartClasses:DataTransform):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Preprocesses the series and transform for display. You typically do not call
this method directly. Instead, this method is called automatically during the
chart control's commitProperties() cycle when the series has
been invalidated by a call to the invalidateSeries() method.
By default, this method calls the customizeSeries() method once for each series in the set.
Chart subclasses can override this method to add customization logic that is global to the whole series set.
Parameters
seriesSet:Array — An array of series to preprocess.
| |
transform:mx.charts.chartClasses:DataTransform — The transform used by the series.
|
Array — An array of series with the series set applied.
|
clearSelection | () | method |
public function clearSelection():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Deselects all selected chart items in the chart control. Sets the currentState property of all chart items in the
chart to none.
customizeSeries | () | method |
protected function customizeSeries(seriesGlyph:Series, i:uint):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Applies per-series customization and formatting to the series of the chart.
This method is called once for each series when the series
has been changed by a call to the invalidateSeries() method.
Parameters
seriesGlyph:Series — The series to customize.
| |
i:uint — The series' index in the series array.
|
dragCompleteHandler | () | method |
protected function dragCompleteHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles events of type DragEvent.DRAG_COMPLETE. This method
removes the item from the data provider.
Parameters
event:DragEvent — The DragEvent object.
|
dragDropHandler | () | method |
protected function dragDropHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles events of type DragEvent.DRAG_DROP. This method hides
the UI feeback by calling the hideDropFeedback() method.
Parameters
event:DragEvent — The DragEvent object.
|
dragEnterHandler | () | method |
protected function dragEnterHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles events of type DragEvent.DRAG_ENTER. This method
determines if the DragSource object contains valid elements and uses
the showDropFeedback() method to set up the UI feedback.
Parameters
event:DragEvent — The DragEvent object.
|
dragExitHandler | () | method |
protected function dragExitHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles events of type DragEvent.DRAG_EXIT. This method hides
the UI feeback by calling the hideDropFeedback() method.
Parameters
event:DragEvent — The DragEvent object.
|
dragOverHandler | () | method |
protected function dragOverHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles events of type DragEvent.DRAG_OVER. This method
determines whether the DragSource object contains valid elements and uses
the showDropFeedback() method to set up the UI feeback.
Parameters
event:DragEvent — The DragEvent object.
|
dragStartHandler | () | method |
findDataPoints | () | method |
public function findDataPoints(x:Number, y:Number):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an array of HitData objects that describe
the nearest data point to the coordinates passed to the method.
The x and y arguments should be values
in the coordinate system of the ChartBase object.
This method adheres to the limits specified by the
mouseSensitivity property of the ChartBase object
when looking for nearby data points.
Parameters
x:Number — The x coordinate relative to the ChartBase object.
| |
y:Number — The y coordinate relative to the ChartBase object.
|
Array — An array of HitData objects.
|
Related API Elements
getAllDataPoints | () | method |
public function getAllDataPoints():Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an array of HitData objects representing the chart items in the underlying objects that implement the IChartElement2 interface.
ReturnsArray — An array of HitData objects that represent the data points.
|
getFirstItem | () | method |
public function getFirstItem(direction:String):ChartItem| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the first item in the chart, with respect to the axes.
Parameters
direction:String — The direction in which the first item should be returned. Possible values
are ChartBase.NAVIGATE_HORIZONTAL and ChartBase.NAVIGATE_VERTICAL.
|
ChartItem — The corresponding ChartItem object.
|
getItemsInRegion | () | method |
public function getItemsInRegion(value:Rectangle):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets all the chart items that are within the defined rectangular region. You call this method to determine what chart items are under a particular rectangular region.
Individual chart types determine whether their chart item is under the region. The point should be in the global coordinate space.
Parameters
value:Rectangle — The rectangular region.
|
Array — An array of ChartItem objects.
|
getLastItem | () | method |
public function getLastItem(direction:String):ChartItem| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the last chart item in the chart, with respect to the axes.
Parameters
direction:String — The direction in which the last item should be returned. Possible values
are ChartBase.NAVIGATE_HORIZONTAL and ChartBase.NAVIGATE_VERTICAL.
|
ChartItem — The corresponding ChartItem object.
|
getNextItem | () | method |
public function getNextItem(direction:String):ChartItem| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the chart item next to the currently focused item in the chart, with respect to the axes. If no chart items are currently selected, then this method returns the first item in the first series.
Parameters
direction:String — The direction in which the next item should be returned. Possible values
are ChartBase.NAVIGATE_HORIZONTAL and ChartBase.NAVIGATE_VERTICAL.
|
ChartItem — The corresponding ChartItem object.
|
getPreviousItem | () | method |
public function getPreviousItem(direction:String):ChartItem| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the chart item that is before the currently focused item in the chart, with respect to the axes. If no chart items are currently selected, then this method returns the first item in the first series.
Parameters
direction:String — The direction in which the previous item should be returned. Possible values
are ChartBase.NAVIGATE_HORIZONTAL and ChartBase.NAVIGATE_VERTICAL.
|
ChartItem — The corresponding ChartItem object.
|
hideData | () | method |
public function hideData():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the chart that the underlying data displayed in the chart has been changed. Chart series and elements call this function when their rendering has changed in order to trigger a coordinated execution of show and hide data effects. You typically do not call this method on the chart directly.
hideDropFeedback | () | method |
public function hideDropFeedback(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hides the drop indicator that indicates that a drag-and-drop operation is allowed.
Parameters
event:DragEvent — A DragEvent object that contains information about the
mouse location.
|
invalidateChildOrder | () | method |
protected function invalidateChildOrder():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the chart that its child list was modified and should be reordererd.
Derived chart classes can call this method to trigger a call to the chart's internal
updateChildOrder() method on the next commitProperties() cycle.
invalidateData | () | method |
protected function invalidateData():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Triggers a redraw of the chart. Call this method when you add or change the chart's series or data providers.
invalidateSeries | () | method |
protected function invalidateSeries():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the chart that its series array was modified and
should be reprocessed. Derived chart classes can call this method to trigger a
call to the chart's internal updateSeries() method on the next commitProperties() cycle.
invalidateSeriesStyles | () | method |
public function invalidateSeriesStyles():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Triggers a redraw of the chart. Call this method when you change the style properties of the chart's series.
legendDataChanged | () | method |
public function legendDataChanged():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatches a new LegendDataChanged event.
positionAllDataTips | () | method |
protected function positionAllDataTips(hitSet:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Defines the locations of DataTip objects on the chart when the
showAllDataTips property is set to true.
This method ensures that DataTips do not overlap each other
(if multiple DataTips are visible) or overlap their target data items.
Parameters
hitSet:Array — An Array of HitData objects.
|
positionDataTips | () | method |
protected function positionDataTips():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Defines the locations of DataTip objects on the chart. This method ensures that DataTip objects do not overlap each other (if multiple DataTip objects are visible) or overlap their target data items.
setActualSize | () | method |
override public function setActualSize(w:Number, h:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the height and width of this object.
Parameters
w:Number — The width, in pixels, of this object.
| |
h:Number — The height, in pixels, of this object.
|
showDropFeedback | () | method |
public function showDropFeedback(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Displays a drop indicator under the mouse pointer to indicate that a drag-and-drop operation is allowed. The drop indicator also indicates where the items will be dropped.
Parameters
event:DragEvent — A DragEvent object that contains information about where
the mouse pointer is.
|
updateAllDataTips | () | method |
public function updateAllDataTips():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Displays all noninteractive data tips
if showAllDataTips is set.
Event Detail
change | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the selection changes in the chart.
Event type constant; indicates that the selection in the chart has changed.chartClick | Event |
Event Object Type:
property ChartEvent.type =
mx.charts.events.ChartEventproperty ChartEvent.type =
mx.charts.events.ChartEvent.CHART_CLICK| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when no data point is found under the mouse pointer
when mouse is clicked on chart.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
chartDoubleClick | Event |
Event Object Type:
property ChartEvent.type =
mx.charts.events.ChartEventproperty ChartEvent.type =
mx.charts.events.ChartEvent.CHART_DOUBLE_CLICK| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when no data point is found under the mouse pointer
when mouse is double-clicked on chart.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemClick | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.MOUSE_CLICK_DATA| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is clicked.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemDoubleClick | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_DOUBLE_CLICK| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is double clicked.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemMouseDown | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_MOUSE_DOWN| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is pressed down.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemMouseMove | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_MOUSE_MOVE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the mouse pointer moves while over a data point.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemMouseUp | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_MOUSE_UP| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is released.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemRollOut | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_ROLL_OUT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the closest data point under the mouse pointer changes.
Flex considers only data points within the radius determined by
the mouseSensitivity property.
itemRollOver | Event |
Event Object Type:
property ChartItemEvent.type =
mx.charts.events.ChartItemEventproperty ChartItemEvent.type =
mx.charts.events.ChartItemEvent.ITEM_ROLL_OVER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a new data point is found under the mouse pointer.
Flex only considers data points within the radius determined by
the mouseSensitivity property.
Constant Detail
HORIZONTAL | Constant |
public static const HORIZONTAL:String = "horizontal"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The value of this constant is passed to methods such as getNextItem() and getPrevItem().
These methods use this constant to determine which item or series to select when the user
presses a key such as the left arrow.
For example, if the left arrow or right arrow key was pressed, the direction is set to "horizontal"
(ChartBase.HORIZONTAL).
VERTICAL | Constant |
public static const VERTICAL:String = "vertical"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The value of this constant is passed to methods such as getNextItem() and getPrevItem().
These methods use this constant to determine which item or series to select when the user
presses a key such as the left arrow.
For example, if the up arrow or down arrow key was pressed, the direction is set to "vertical"
(ChartBase.VERTICAL).
Wed Nov 21 2018, 06:34 AM -08:00