Package | mx.charts.chartClasses |
Class | public class Series |
Inheritance | Series ChartElement DualStyleObject UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Subclasses | AreaSeries, BarSeries, BubbleSeries, ColumnSeries, HLOCSeriesBase, LineSeries, PieSeries, PlotSeries, StackedSeries |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | ||
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 | ||
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 | ||
chartDataProvider : Object [write-only]
The data provider assigned to the enclosing chart. | ChartElement | ||
className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | ||
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 | ||
dataFunction : Function
Specifies a method that returns the value that should be used for
positioning the current chart item in the series. | Series | ||
dataProvider : Object
A data provider assigned to the this specific element. | ChartElement | ||
dataTipItems : Array
Array of chart items for which data tips are to be shown
non-interactively on the chart. | Series | ||
dataTransform : mx.charts.chartClasses:DataTransform [override]
The DataTransform object that the element is associated with. | Series | ||
depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | ||
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 | ||
displayName : String
The name of the series, for display to the user. | Series | ||
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 | ||
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 | ||
filterData : Boolean
If filterFuction or filterDataValues is set,
filterData is ignored. | Series | ||
filterDataValues : String
If filterFuction is set, filterDataValues and
filterData are ignored. | Series | ||
filterFunction : Function
Specifies a method that returns the array of chart items in the series
that are to be displayed. | Series | ||
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 | ||
interactive : Boolean
Determines whether data tips appear when users interact
with chart data on the screen. | Series | ||
internalStyleName : Object
The name of a class selector this instance inherits values from. | DualStyleObject | ||
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 | ||
items : Array [read-only]
Gets all the items that are there in the series after filtering. | Series | ||
labelContainer : Sprite [read-only]
The DisplayObject that displays labels rendered by this element. | ChartElement | ||
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 LegendData instances that describe the items
that should show up in a legend representing this series. | Series | ||
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
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | ||
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 | ||
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 | ||
selectable : Boolean
Specifies whether a series is selectable or not. | Series | ||
selectedIndex : int
Index of the selected item in the data provider of the series. | Series | ||
selectedIndices : Array
An Array of indexes of the selected items in the data provider of the series. | Series | ||
selectedItem : ChartItem
The chart item that is selected in the series. | Series | ||
selectedItems : Array
An Array of chart items that are selected in the series. | Series | ||
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 | ||
transitionRenderData : Object
A render data structure passed in by a running transtion. | Series | ||
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 |
Property | Defined By | ||
---|---|---|---|
chart : ChartBase [read-only]
Refers to the chart component containing this element. | ChartElement | ||
currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | ||
cursor : IViewCursor
Each ChartElement carries a cursor associated with their dataProvider
for their own internal use. | ChartElement | ||
hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | ||
renderData : Object [read-only]
Stores the information necessary to render this series. | Series | ||
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 |
Method | Defined By | ||
---|---|---|---|
Series()
Constructor. | Series | ||
[override]
Adds a child DisplayObject after the end of this child list. | ChartElement | ||
[override]
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | ChartElement | ||
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 | ||
Called by the SeriesInterpolate effect to initiate an interpolation effect. | Series | ||
Queues a function to be called later. | UIComponent | ||
Called by the enclosing chart to indicate that the current state
of the chart has changed. | ChartElement | ||
[override]
Called by the chart to allow associated elements
to claim style selectors from its chartSeriesStyles Array. | Series | ||
Deletes a style property from this component instance. | UIComponent | ||
Called by the enclosing chart to collect any transitions
a particular element might play when the chart changes state. | ChartElement | ||
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 | ||
Converts a tuple of data values to an x-y coordinate on screen. | ChartElement | ||
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement. | ChartElement | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | ||
[override]
Dispatches an event into the event flow. | UIComponent | ||
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 | ||
Called by the SeriesInterpolate effect to end an interpolation effect. | Series | ||
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
Finds the closest data point represented by the element
under the given coordinates. | ChartElement | ||
Called after printing is complete. | UIComponent | ||
Returns an array of HitData of the items of all the underlying
ChartElements whose dataTips are to be shown when
showAllDataTips is set to true on
chart
| ChartElement | ||
Provides the automation object at the specified index. | UIComponent | ||
Provides the automation object list . | UIComponent | ||
You typically retrieve the Axis instance directly through a named property
(such as for a Cartesian-based series horizontalAxis, verticalAxis,
or radiusAxis). | Series | ||
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 | ||
Fills in the elementBounds, bounds,
and visibleBounds properties of a renderData
structure that is generated by this series. | Series | ||
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 object that currently has focus. | UIComponent | ||
Gets all the items that are in a rectangular region for the series. | Series | ||
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 | ||
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 | ||
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 | ||
Captures the before and after states of the series for animation. | Series | ||
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 | ||
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 | ||
Called by the SeriesInterpolate effect to advance an interpolation. | Series | ||
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 | ||
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 | ||
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 a coordinate on screen to a tuple of data values. | ChartElement | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Called when the mapping of one or more associated axes changes. | ChartElement | ||
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 actual size of this object. | Series | ||
Assigns an Axis instance to a particular dimension of the chart. | Series | ||
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 | ||
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 | ||
[override]
Calls the legendDataChanged() method. | Series | ||
[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 | ||
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 |
Method | Defined By | ||
---|---|---|---|
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 | ||
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Determines if the call to the measure() method can be skipped. | UIComponent | ||
Performs any final processing after child objects are created. | UIComponent | ||
[override]
Processes the properties set on the component. | Series | ||
Create child objects of the component. | UIComponent | ||
Creates a unique id to represent the dataPoint
for comparison purposes. | ChartElement | ||
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
Creates the object using a given moduleFactory. | UIComponent | ||
Indicates the underlying data represented by the element has changed. | ChartElement | ||
This is used if you do not set a custom function as the filterFunction for the series. | Series | ||
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
The default handler for the dragStart event. | Series | ||
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | ||
extractMinMax(cache:Array, measureName:String, desc:DataDescription, calculateInterval:Boolean = false):void
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | ||
The event handler called when a UIComponent object gets focus. | UIComponent | ||
The event handler called when a UIComponent object loses focus. | UIComponent | ||
getMissingInterpolationValues(sourceProps:Object, srcCache:Array, destProps:Object, destCache:Array, index:Number, customData:Object):void
Fills in missing values in an interpolation structure. | Series | ||
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 | ||
initializeInterpolationData(srcCache:Array, dstCache:Array, iProps:Object, cacheType:Class = null, customData:Object = null):Object
Helper method to implement the interpolation effect. | Series | ||
Informs the series that the underlying data
in the data provider has changed. | Series | ||
Informs the series that the filter of the data against the axes
has changed and must be recalculated. | Series | ||
Informs the series that the mapping of the data into numeric values
has changed and must be recalculated. | Series | ||
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | ||
Informs the series that the transform of the data to screen coordinates
has changed and must be recalculated. | Series | ||
Informs the series that a significant change has occured
in the display of data. | Series | ||
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 | ||
Updates the Legend items when the series display name changes
by dispatching a new LegendDataChanged event. | Series | ||
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | ||
Called when a new dataProvider is assigned to the element. | ChartElement | ||
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 | ||
Removes any item from the provided cache whose field
property is NaN. | Series | ||
Called when the underlying data that the series represents
has changed and needs to be reloaded from the data provider. | Series | ||
[override]
Draws the object and/or sizes and positions its children. | Series | ||
Called when the underlying data the series represents
needs to be filtered against the ranges represented by the axes
of the associated data transform. | Series | ||
Called when the underlying data the series represents
needs to be mapped to numeric representations. | Series | ||
Called when the underlying data the series represents
needs to be transformed from data to screen values
by the axes of the associated data transform. | Series | ||
Calls the updateData() and
updateMapping() methods of the series, if necessary. | Series | ||
Calls the updateFilter() and
updateTransform() methods of the series, if necessary. | Series |
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.
Effect | Description | Defined By | ||
---|---|---|---|---|
Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | |||
Triggering Event: creationComplete Played when the component is created. | UIComponent | |||
Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent | |||
Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent | |||
hideDataEffect | Triggering Event: hideData Defines the effect that Flex uses as it hides the current data from view. | Series | ||
Triggering Event: hide Played when the component becomes invisible. | UIComponent | |||
Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | |||
Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | |||
Triggering Event: move Played when the component is moved. | UIComponent | |||
Triggering Event: removed Played when the component is removed from a Container. | UIComponent | |||
Triggering Event: resize Played when the component is resized. | UIComponent | |||
Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | |||
Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent | |||
showDataEffect | Triggering Event: showData Defines the effect that Flex uses as it moves the current data into its final position on the screen. | Series | ||
Triggering Event: show Played when the component becomes visible. | UIComponent |
dataFunction | property |
dataFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a method that returns the value that should be used for
positioning the current chart item in the series.
If this property is set, the return value of the custom data function takes precedence over the
other related properties, such as xField
and yField
for AreaSeries, BarSeries, BubbleSeries, ColumnSeries, LineSeries, and PlotSeries.
For BubbleSeries, the return value takes precedence over the radiusField
property.
For PieSeries, the return value takes precedence over the field
property.
The custom dataFunction
for a series has the following signature:
function_name (series:Series, item:Object, fieldName:String):Object { ... }
series
is the current series that uses this dataFunction
.
item
is the item in the data provider.
fieldName
is the field in current chart item that is to be populated.
This function returns an object.
You typically use the dataFunction
property to access fields in a data provider that are not
scalar values, but are instead nested in the data provider. For example, the following data
requires a data function to access the fields for a chart's data provider:
{month: "Aug", close: {High:45.87,Low:12.2}, open:25.19}
The following example returns a value from this data provider:
public function myDataFunction(series:Series, item:Object, fieldName:String):Object { if (fieldName == 'yValue') return(item.close.High); else if (fieldName == "xValue") return(item.month); else return null; }
Implementation
public function get dataFunction():Function
public function set dataFunction(value:Function):void
dataTipItems | property |
dataTipItems:Array
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Array of chart items for which data tips are to be shown non-interactively on the chart.
Implementation
public function get dataTipItems():Array
public function set dataTipItems(value:Array):void
dataTransform | property |
dataTransform:mx.charts.chartClasses:DataTransform
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The DataTransform object that the element is associated with. A DataTransform object represents an association between a set of elements and a set of axis objects used to transform those elements from data space to screen coordinates and back. A chart element uses its associated DataTransform object to calculate how to render its data.
Implementation
override public function get dataTransform():mx.charts.chartClasses:DataTransform
override public function set dataTransform(value:mx.charts.chartClasses:DataTransform):void
displayName | property |
displayName:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the series, for display to the user. This property is used to represent the series in user-visible labels, such as data tips.
Implementation
public function get displayName():String
public function set displayName(value:String):void
filterData | property |
filterData:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
If filterFuction
or filterDataValues
is set,
filterData
is ignored.
true
if the series filters its data
before displaying.
If a series renders data that contains missing values
(such as null
, undefined
, or NaN
),
or renders values that are outside the range of the chart axes,
this property should be set to true
(the default).
If you know that all of the data in the series is valid,
you can set this to false
to improve performance.
Implementation
public function get filterData():Boolean
public function set filterData(value:Boolean):void
filterDataValues | property |
filterDataValues:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
If filterFuction
is set, filterDataValues
and
filterData
are ignored.
If filterDataValues
property is set to none
,
series will not filter its data before displaying.
If filterDataValues
is set to nulls
, series
filters data like null
, undefined
, or NaN
before displaying.
If this property is set to outsideRange
, series
filters its data like null
, undefined
, or NaN
and also the values that are outside the range of the chart axes.
If you know that all of the data in the series is valid,
you can set this to none
to improve performance.
Implementation
public function get filterDataValues():String
public function set filterDataValues(value:String):void
filterFunction | property |
filterFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a method that returns the array of chart items in the series
that are to be displayed.
If this property is set, the return value of the custom filter function takes
precedence over the filterDataValues
and filterData
properties.
But if it returns null, then filterDataValues
and filterData
will be
prefered in that order.
The custom filterFunction
has the following signature:
function_name (cache:Array):Array { ... }
cache
is a reference to the array of chart items that are to be filtered.
This function returns an array of chart items that are to be displayed.
Implementation
public function get filterFunction():Function
public function set filterFunction(value:Function):void
Example
How to use this example
public function myFilterFunction(cache:Array):Array { var filteredCache:Array=[]; var n:int = cache.length; for(var i:int = 0; i < n; i++) { var item:ColumnSeriesItem = ColumnSeriesItem(cache[i]); if(item.yNumber > 0 && item.yNumber < 700) { filteredCache.push(item); } } return filteredCache; }
If you specify a custom filter function for your chart series and you
want to filter null values or values outside the range of axes, you must manually
filter them using the custom filter function. filterDataValues
or
filterData
cannot be used.
interactive | property |
interactive:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether data tips appear when users interact
with chart data on the screen.
Set to false
to prevent the series
from showing data tips or generating hit data.
The default value is true.
Implementation
public function get interactive():Boolean
public function set interactive(value:Boolean):void
items | property |
items:Array
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets all the items that are there in the series after filtering.
Individual series determine the list of items that are to be returned.
Implementation
public function get items():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 LegendData instances that describe the items that should show up in a legend representing this series. Derived series classes override this getter and return legend data that is specific to their styles and data representation method. Although most series types return only a single LegendData instance, some series types, such as PieSeries and StackedSeries, return multiple instances representing individual items in the Array, or multiple ways of rendering data.
Implementation
public function get legendData():Array
renderData | property |
selectable | property |
selectedIndex | property |
selectedIndex:int
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Index of the selected item in the data provider of the series. If multiple items are selected, then this property refers to the most recently selected item.
Implementation
public function get selectedIndex():int
public function set selectedIndex(value:int):void
selectedIndices | property |
selectedIndices:Array
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of indexes of the selected items in the data provider of the series.
Implementation
public function get selectedIndices():Array
public function set selectedIndices(value:Array):void
selectedItem | property |
selectedItem:ChartItem
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The chart item that is selected in the series. If multiple items are selected, then this property refers to the most recently selected item.
Implementation
public function get selectedItem():ChartItem
public function set selectedItem(value:ChartItem):void
selectedItems | property |
transitionRenderData | property |
transitionRenderData:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
A render data structure passed in by a running transtion.
When a series effect is set to play on a series, it first captures
the current state of the series by asking for its render data.
The transition modifies the render data to create the desired effect
and passes the structure back to the series for display.
If the transitionRenderData
property is a value other than null
,
a series uses its contents to update its display.
Implementation
public function get transitionRenderData():Object
public function set transitionRenderData(value:Object):void
Series | () | Constructor |
public function Series()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
beginInterpolation | () | method |
public function beginInterpolation(sourceRenderData:Object, destRenderData:Object):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the SeriesInterpolate effect to initiate an interpolation effect.
The effect passes in the source and destination data
for the series to interpolate between.
The effect passes the return value of this method
repeatedly to the interpolate()
method of the series
to advance the animation for the duration of the effect.
The series calculates the data it needs to
perform the interpolation and returns it in this method.
Parameters
sourceRenderData:Object — The source data for the series to interpolate between.
| |
destRenderData:Object — The destination data for the series to interpolate between.
|
Object — The data the series needs to perform the interpolation.
|
cacheDefaultValues | () | method |
protected function cacheDefaultValues(measureName:String, cache:Array, fieldName:String):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Caches the values stored in the measureName
property
from the original dataProvider items in the chart item's
fieldName
property.
If the the value of the measureName
property is null
or the empty string, this method assumes the original data provider items
are raw values and caches them instead.
Parameters
measureName:String — Name of the property of chart item whose value should be set
by a value from the dataProvider based on the fieldName property.
For example, measureName can be the xValue, yValue, xNumber, yNumber, etc,
provided they are properties of the chart item.
| |
cache:Array — An array of chart items.
| |
fieldName:String — The label (in the data provider's item) whose value should be
used to set the chart item's measureName property. For example,
if the data provider has an item like {Country:"US", medals:10} ,
then the value of fieldName can be "Country" or "medals".
|
Boolean — false if the value of the measureName property
is the empty string or null; otherwise true .
|
cacheIndexValues | () | method |
protected function cacheIndexValues(measureName:String, cache:Array, fieldName:String):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Caches the values stored in the measureName
property
from the original dataProvider items in the chart item's
fieldName
property.
If the measureName
property is null
or the empty string, this method stores the index of the items
in the fieldName
property instead.
Parameters
measureName:String — Name of the property of chart item whose value should be set
by a value from the dataProvider based on the fieldName property.
For example, measureName can be the xValue, yValue, xNumber, yNumber, etc,
provided they are properties of the chart item.
| |
cache:Array — An array of chart items.
| |
fieldName:String — The label (in the data provider's item) whose value should be
used to set the chart item's measureName property. For example,
if the data provider has an item like {Country:"US", medals:10} ,
then the value of fieldName can be "Country" or "medals".
|
Boolean — false if the value of the measureName property
is the empty string or null; otherwise true .
|
cacheNamedValues | () | method |
protected function cacheNamedValues(measureName:String, cache:Array, fieldName:String):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Caches the values stored in the measureName
property
from the original dataProvider items in the chart item's
fieldName
property.
Parameters
measureName:String — Name of the property of chart item whose value should be set
by a value from the dataProvider based on the fieldName property.
For example, measureName can be the xValue, yValue, xNumber, yNumber, etc,
provided they are properties of the chart item.
| |
cache:Array — An array of chart items.
| |
fieldName:String — The label (in the data provider's item) whose value should be
used to set the chart item's measureName property. For example,
if the data provider has an item like {Country:"US", medals:10} ,
then the value of fieldName can be "Country" or "medals".
|
Boolean — false if the value of the measureName property
is the empty string or null; otherwise true .
|
claimStyles | () | method |
override public function claimStyles(styles:Array, firstAvailable:uint):uint
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the chart to allow associated elements
to claim style selectors from its chartSeriesStyles Array.
Each chart has an associated set of selectors that are
implicitly assigned to contained elements that require them.
Implementing this function gives an element a chance to 'claim'
elements out of that set, as necessary.
An element that requires N style selectors claims the values
from styles[firstAvailable]
to
styles[firstAvailable + N - 1]
.
Parameters
styles:Array — An Array of styles to claim.
| |
firstAvailable:uint — The first style selector in the Array to claim.
|
uint — The new value for firstAvailable
after claiming any styles (for example,
firstAvailable + N).
|
commitProperties | () | method |
override protected function commitProperties():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Processes the properties set on the component. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly.
Flex calls the commitProperties()
method when you
use the addChild()
method to add a component to a container,
or when you call the invalidateProperties()
method of the component.
Calls to the commitProperties()
method occur before calls to the
measure()
method. This lets you set property values that might
be used by the measure()
method.
Some components have properties that affect the number or kinds
of child objects that they need to create, or have properties that
interact with each other, such as the horizontalScrollPolicy
and horizontalScrollPosition
properties.
It is often best at startup time to process all of these
properties at one time to avoid duplicating work.
defaultFilterFunction | () | method |
protected function defaultFilterFunction(cache:Array):Array
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
This is used if you do not set a custom function as the filterFunction for the series. Individual series should overwrite this.
Parameters
cache:Array — An array of objects.
|
Array — An array of objects.
|
dragStartHandler | () | method |
endInterpolation | () | method |
public function endInterpolation(interpolationData:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the SeriesInterpolate effect to end an interpolation effect. The effect uses this method to complete the interpolation and clean up any temporary state associated with the effect.
Parameters
interpolationData:Object — An object that defines the source data (for the show effect)
that represents the "before" state of the series, and the destination data
(for the hide effect) that represents the "after" state of the series.
|
extractMinInterval | () | method |
protected function extractMinInterval(cache:Array, measureName:String, desc:DataDescription):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects.
Derived classes can call this method from their
implementations of the describeData()
method to fill in the details
of the DataDescription structure.
Parameters
cache:Array — An array of chart items.
| |
measureName:String — Name of the property of chart item whose value should be set
by a value from the dataProvider based on the fieldName property.
For example, measureName can be the xValue, yValue, xNumber, yNumber, etc,
provided they are properties of the chart item.
| |
desc:DataDescription — DataDescription object of the series. This property holds bounded values such
as min , max , and minInterval of the series.
|
extractMinMax | () | method |
protected function extractMinMax(cache:Array, measureName:String, desc:DataDescription, calculateInterval:Boolean = false):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects.
Derived classes can call this method from their
implementations of the describeData()
method to fill in the details
of the DataDescription structure.
Parameters
cache:Array — An array of chart items.
| |
measureName:String — Name of the property of chart item whose value should be set
by a value from the dataProvider based on the fieldName property.
For example, measureName can be the xValue, yValue, xNumber, yNumber, etc,
provided they are properties of the chart item.
| |
desc:DataDescription — DataDescription object of the series. This property holds bounded values such
as min , max , and minInterval of the series.
| |
calculateInterval:Boolean (default = false ) — Determines whether to extract the minInterval for the
DataDescription desc by using the ChartItem objects in the cache property.
|
getAxis | () | method |
public function getAxis(dimension:String):IAxis
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
You typically retrieve the Axis instance directly through a named property
(such as for a Cartesian-based series horizontalAxis
, verticalAxis
,
or radiusAxis
).
This is a low-level accessor.
Parameters
dimension:String — The dimension that you want the axis for.
|
IAxis — The Axis instance for a particular dimension of the chart.
|
getElementBounds | () | method |
public function getElementBounds(renderData:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Fills in the elementBounds
, bounds
,
and visibleBounds
properties of a renderData
structure that is generated by this series.
Effect classes call this method to fill in these fields
for use in implementing various effect types.
Derived classes should implement this method
to generate the bounds of the items of the series only when requested.
Parameters
renderData:Object — The structure that is generated by this series.
|
getItemsInRegion | () | method |
public function getItemsInRegion(r:Rectangle):Array
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets all the items that are in a rectangular region for the series. Call this function to determine what items are in a particular rectangular region in that series.
Individual series determine whether their chart item is under the region. The point should be in the global coordinate space.
Parameters
r:Rectangle — A Rectangle object that defines the region.
|
Array — An Array of ChartItem objects that are within the specified rectangular region.
|
Related API Elements
getMissingInterpolationValues | () | method |
protected function getMissingInterpolationValues(sourceProps:Object, srcCache:Array, destProps:Object, destCache:Array, index:Number, customData:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Fills in missing values in an interpolation structure.
When a series calls the initializeInterpolationData()
method,
it passes in Arrays of source and destination values
for the interpolation.
If either of those two Arrays is incomplete, the series must
provide "appropriate" placeholder values for the interpolation.
How those placeholder values are determined
is specific to the series type.
Series extenders should override this method
to provide those placeholder values.
Parameters
sourceProps:Object — An object containing the source values
being interpolated for a particular item.
When this method exits, all properties in this object
should have values other than NaN .
| |
srcCache:Array — The Array of source chart items that are being interpolated.
| |
destProps:Object — An object containing the destination values
that are being interpolated for a particular item.
When this method exits, all properties in this Object
should have values other than NaN .
| |
destCache:Array — The Array of destination chart items that are being interpolated.
| |
index:Number — The index of the item that is being populated in the cache.
| |
customData:Object — The data that was passed by the series
into the initializeInterpolationData() method.
|
getRenderDataForTransition | () | method |
public function getRenderDataForTransition(type:String):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Captures the before and after states of the series for animation. This method is typically called by the effects classes.
If you implement a custom series type, you generally do not override this method.
Instead, you should override the renderData()
accessor.
Parameters
type:String — Specifies whether the effect is requesting
a description of the data being hidden, or the new data being shown.
|
Object — A copy of the data needed to represent the data of the series.
|
initializeInterpolationData | () | method |
protected function initializeInterpolationData(srcCache:Array, dstCache:Array, iProps:Object, cacheType:Class = null, customData:Object = null):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Helper method to implement the interpolation effect.
A custom series can call this method from its
beginInterpolation()
method to initialize
a data structure to interpolate an arbitrary set
of numeric properties over the life of the effect.
You can pass that data structure to the
applyInterpolation()
utility method to actually modify
the values when the interpolate()
method is called.
Parameters
srcCache:Array — An Array of objects whose fields
contain the beginning values for the interpolation.
| |
dstCache:Array — An Array of objects whose fields
contain the ending values for the interpolation.
| |
iProps:Object — A hash table whose keys identify the names
of the properties from the cache to be interpolated.
| |
cacheType:Class (default = null ) — The class to instantiate that holds the delta values
computed for the interpolation.
Typically this is null ,
in which case a generic Object is used.
| |
customData:Object (default = null ) — An object containing series-specific data.
When the initialization process encounters a missing value,
it calls the getMissingInterpolationValues()
method of the series to fill in the missing value.
This custom data is passed to that method,
and can be used to pass through arbitrary parameters.
|
Object — A data structure that can be passed
to the applyInterpolation() method.
|
interpolate | () | method |
public function interpolate(interpolationValues:Array, interpolationData:Object):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the SeriesInterpolate effect to advance an interpolation.
The effect calls this once per frame until the interpolation
is complete.
The series is responsible for using the parameters
to render the interpolated values.
By default, the series assumes that interpolationData
is a data structure returned by the
initializeInterpolationData()
method, and passes it
through to the applyInterpolation()
method.
Parameters
interpolationValues:Array — An Array of Numbers, each ranging
from 0 to 1, where the nth number indicates the percentage
of the way in which the nth value in the data series should be
interpolated between the start and end values.
| |
interpolationData:Object — The data returned from the
beginInterpolation() method.
|
invalidateData | () | method |
protected function invalidateData(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the underlying data
in the data provider has changed.
This function triggers calls to the updateData()
,
updateMapping()
, updateFilter()
,
and updateTransform()
methods on the next call
to the commitProperties()
method.
If any data effects are assigned to any elements of the chart,
this method also triggers the show and hide effects.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
invalidateFilter | () | method |
protected function invalidateFilter(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the filter of the data against the axes
has changed and must be recalculated.
Calling this method triggers calls to the updateFilter()
and updateTransform()
methods on the next call
to the commitProperties()
method.
If any data effects are assigned to any elements of the chart,
this method also triggers the show and hide effects.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
invalidateMapping | () | method |
protected function invalidateMapping(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the mapping of the data into numeric values
has changed and must be recalculated.
Calling this function triggers calls to the updateMapping()
,
updateFilter()
, and updateTransform()
methods
on the next call to the commitProperties()
method.
If any data effects are assigned to any elements of the chart,
this method also triggers the show and hide effects.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
invalidateTransform | () | method |
protected function invalidateTransform(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the transform of the data to screen coordinates
has changed and must be recalculated.
Calling this function triggers a call to the
updateTransform()
method on the next call
to the commitProperties()
method.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
invalidateTransitions | () | method |
protected function invalidateTransitions():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that a significant change has occured in the display of data. This triggers any ShowData and HideData effects.
legendDataChanged | () | method |
protected function legendDataChanged():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Updates the Legend items when the series display name changes by dispatching a new LegendDataChanged event.
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 actual size of this object.
This method is mainly for use in implementing the
updateDisplayList()
method, which is where
you compute this object's actual size based on
its explicit size, parent-relative (percent) size,
and measured size.
You then apply this actual size to the object
by calling setActualSize()
.
In other situations, you should be setting properties
such as width
, height
,
percentWidth
, or percentHeight
rather than calling this method.
Parameters
w:Number — The new width for this object.
| |
h:Number — The new height for this object.
|
setAxis | () | method |
public function setAxis(dimension:String, value:IAxis):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Assigns an Axis instance to a particular dimension of the chart.
You typically set the Axis instance directly through a named property
(such as for a Cartesian-based series horizontalAxis
, verticalAxis
,
or radiusAxis
).
This is a low-level accessor.
Parameters
dimension:String — The dimension of the chart that you want to assign the Axis to.
| |
value:IAxis — The Axis to assign to the chart's dimension.
|
stripNaNs | () | method |
protected function stripNaNs(cache:Array, field:String):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes any item from the provided cache whose field
property is NaN
.
Derived classes can call this method from their implementation of the updateFilter()
method to remove any ChartItem objects that were filtered out by the axes.
Parameters
cache:Array — An array of chart items.
| |
field:String — The field property to remove an item from.
|
stylesInitialized | () | method |
override public function stylesInitialized():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Calls the legendDataChanged()
method.
updateData | () | method |
protected function updateData():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the underlying data that the series represents
has changed and needs to be reloaded from the data provider.
If you implement custom series types, you should override this method
and load all data necessary to render the series
out of the backing data provider.
You must also be sure to call the super.updateData()
method
in your subclass.
You do not generally call this method directly.
Instead, to guarantee that your data has been updated
at a given point, call the validateData()
method
of the Series class.
updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the object and/or sizes and positions its children. This is an advanced method that you might override when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
updateDisplayList()
method when the component is added to a container
using the addChild()
method, and when the component's
invalidateDisplayList()
method is called.
If the component has no children, this method
is where you would do programmatic drawing
using methods on the component's Graphics object
such as graphics.drawRect()
.
If the component has children, this method is where
you would call the move()
and setActualSize()
methods on its children.
Components can do programmatic drawing even if
they have children. In doing either, use the
component's unscaledWidth
and unscaledHeight
as its bounds.
It is important to use unscaledWidth
and
unscaledHeight
instead of the width
and height
properties.
Parameters
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
| |
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
updateFilter | () | method |
protected function updateFilter():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the underlying data the series represents
needs to be filtered against the ranges represented by the axes
of the associated data transform.
This can happen either because the underlying data has changed
or because the range of the associated axes has changed.
If you implement a custom series type, you should override this method
and filter out any outlying data using the filterCache()
method of the axes managed by its associated data transform.
The filterCache()
method converts any values
that are out of range to NaN
.
You must be sure to call the super.updateFilter()
method
in your subclass.
You should not generally call this method directly.
Instead, if you need to guarantee that your data has been filtered
at a given point, call the validateTransform()
method
of the Series class.
You can generally assume that your updateData()
and updateMapping()
methods have been called
prior to this method, if necessary.
updateMapping | () | method |
protected function updateMapping():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the underlying data the series represents
needs to be mapped to numeric representations.
This can happen either because the underlying data has changed
or because the axes used to render the series have changed
in some relevant way.
If you implement a custom series, you should override this method
and convert the data represented into numeric values by
using the mapCache()
method of the axes
that are managed by its associated data transform.
You must also be sure to call the super.updateMapping()
method
in your subclass.
You should not generally call this method directly.
Instead, to guarantee that your data has been mapped
at a given point, call the validateData()
method
of the Series class.
You can generally assume that your updateData()
method
has been called prior to this method, if necessary.
updateTransform | () | method |
protected function updateTransform():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the underlying data the series represents
needs to be transformed from data to screen values
by the axes of the associated data transform.
This can happen either because the underlying data has changed,
because the range of the associated axes has changed,
or because the size of the area on screen has changed.
If you implement a custom series type, you should override this method
and transform the data using the transformCache()
method
of the associated data transform.
You must be sure to call the super.updateTransform()
method
in your subclass.
You should not generally call this method directly.
Instead, if you need to guarantee that your data has been filtered
at a given point, call the valiateTransform()
method
of the Series class.
You can generally assume that your updateData()
,
updateMapping()
, and updateFilter()
methods
have been called prior to this method, if necessary.
validateData | () | method |
protected function validateData():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Calls the updateData()
and
updateMapping()
methods of the series, if necessary.
This method is called automatically by the series
from the commitProperties()
method, as necessary,
but a derived series might call it explicitly
if the generated values are needed at an explicit time.
Loading and mapping data against the axes is designed
to be acceptable by the axes at any time.
It is safe this method explicitly at any point.
validateTransform | () | method |
protected function validateTransform():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Calls the updateFilter()
and
updateTransform()
methods of the series, if necessary.
This method is called automatically by the series
during the commitProperties()
method, as necessary,
but a derived series might call it explicitly
if the generated values are needed at an explicit time.
Filtering and transforming of data relies on specific values
being calculated by the axes, which can in turn
depend on the data that is displayed in the chart.
Calling this function at the wrong time might result
in extra work being done, if those values are updated.
Thu Dec 6 2018, 01:12 PM -08:00