| Package | mx.charts.chartClasses |
| Class | public class CartesianDataCanvas |
| Inheritance | CartesianDataCanvas  ChartElement DualStyleObject UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataCanvas |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The drawing region for the canvas is determined by the verticalAxis
and horizontalAxis, if they are specified. Otherwise,
the canvas uses the default axes of the chart to compute the drawing region.
The data coordinates passed as parameters to the drawing APIs can be
actual values of the data coordinate or an object of type CartesianCanvasValue,
which can hold a data coordinate value and an offset, in pixels.
Show MXML Syntax
Hide MXML SyntaxThe <mx:CartesianDataCanvas> tag inherits all the
properties of its parent classes and adds the following properties:
<mx:CartesianDataCanvas
Properties
dataChildren="No default"
horizontalAxis="No default"
includeInRanges="false"
verticalAxis="No default"
/>
Default MXML PropertydataChildren
More examples
| 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 | |
| dataChildren : Array
An array of child objects. | CartesianDataCanvas | ||
| dataProvider : Object
A data provider assigned to the this specific element. | ChartElement | |
| dataTransform : mx.charts.chartClasses:DataTransform [override]
The DataTransform object that the element is associated with. | CartesianDataCanvas | ||
| 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 | |
| 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 | |
| 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 | |
| horizontalAxis : IAxis
Defines the labels, tick marks, and data position
for items on the x-axis. | CartesianDataCanvas | ||
| 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 | |
| includeInRanges : Boolean
If true, the computed range of the chart is affected by this
canvas. | CartesianDataCanvas | ||
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| verticalAxis : IAxis
Defines the labels, tick marks, and data position
for items on the y-axis. | CartesianDataCanvas | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | CartesianDataCanvas | ||
[override]
Adds a child DisplayObject after the end of this child list. | CartesianDataCanvas | ||
[override]
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | CartesianDataCanvas | ||
Adds the specified display object as a child to the current canvas. | CartesianDataCanvas | ||
| 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 | |
beginBitmapFill(bitmap:BitmapData, x:*, y:*, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = true):void
Fills a drawing area with a bitmap image. | CartesianDataCanvas | ||
Note: With the exception of the beginGradientFill() and beginShaderFill() methods, the following information
from the flash.display.Graphics class's beginFill() method applies to this method:
| CartesianDataCanvas | ||
|
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 | |
|
Called by the chart to allow associated elements
to claim style selectors from its chartSeriesStyles Array. | ChartElement | |
Clears the graphics that were drawn to this Graphics object, and resets fill and
line style settings. | CartesianDataCanvas | ||
|
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 | |
Draws a curve using the current line style from the current drawing position to (anchorX, anchorY) and using the
control point that (controlX, controlY) specifies. | CartesianDataCanvas | ||
[override]
Converts a tuple of data values to an x-y coordinate on screen. | CartesianDataCanvas | ||
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
[override]
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement. | CartesianDataCanvas | ||
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
Draws a circle. | CartesianDataCanvas | ||
Draws an ellipse. | CartesianDataCanvas | ||
|
Shows or hides the focus indicator around this component. | UIComponent | |
Draws a rectangle. | CartesianDataCanvas | ||
Draws a rounded rectangle. | CartesianDataCanvas | ||
| 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 | |
Note: With the exception of the beginGradientFill() method, the following information
from the flash.display.Graphics class's endFill() applies to this method:
| CartesianDataCanvas | ||
|
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 | |
|
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 object that currently has focus. | UIComponent | |
|
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 | |
|
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 | |
[override]
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | CartesianDataCanvas | ||
|
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 | |
lineStyle(thickness:Number, color:uint = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):void
Specifies a line style that Flash uses for subsequent calls to other Graphics methods (such as lineTo()
or drawCircle()) for the object. | CartesianDataCanvas | ||
Draws a line using the current line style from the current drawing position to (x, y);
the current drawing position is then set to (x, y). | CartesianDataCanvas | ||
|
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 | |
[override]
Converts a coordinate on screen to a tuple of data values. | CartesianDataCanvas | ||
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
[override]
Called when the mapping of one or more associated axes changes. | CartesianDataCanvas | ||
|
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 | |
Moves the current drawing position to (x, y). | CartesianDataCanvas | ||
|
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 all data children (DisplayObject instances) of the canvas. | CartesianDataCanvas | ||
[override]
Removes the specified child DisplayObject from this child list. | CartesianDataCanvas | ||
[override]
Removes the child DisplayObject at the specified index
from this child list. | CartesianDataCanvas | ||
|
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 | |
|
Sizes the object. | UIComponent | |
|
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 | |
|
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 | |
Updates the position of any child to current canvas. | CartesianDataCanvas | ||
|
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 | |
|
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. | CartesianDataCanvas | ||
|
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 | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
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 canvas that the underlying data
in the data provider has changed. | CartesianDataCanvas | ||
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
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 | |
|
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. | CartesianDataCanvas | ||
[override]
Draws the object and/or sizes and positions its children. | CartesianDataCanvas | ||
Called when the underlying data the canvas represents
needs to be filtered against the ranges represented by the axes
of the associated data transform. | CartesianDataCanvas | ||
Calls the updateMapping()
and updateFilter() methods of the canvas, if necessary. | CartesianDataCanvas | ||
Calls the updateTransform() method of the canvas, if necessary. | CartesianDataCanvas | ||
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.
dataChildren | property |
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):voidhorizontalAxis | property |
horizontalAxis:IAxis| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Defines the labels, tick marks, and data position for items on the x-axis. Use either the LinearAxis class or the CategoryAxis class to set the properties of the horizontal axis as a child tag in MXML or create a LinearAxis or CategoryAxis object in ActionScript.
Implementation
public function get horizontalAxis():IAxis public function set horizontalAxis(value:IAxis):voidincludeInRanges | property |
includeInRanges:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If true, the computed range of the chart is affected by this
canvas.
Implementation
public function get includeInRanges():Boolean public function set includeInRanges(value:Boolean):voidverticalAxis | property |
verticalAxis:IAxis| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Defines the labels, tick marks, and data position for items on the y-axis. Use either the LinearAxis class or the CategoryAxis class to set the properties of the vertical axis as a child tag in MXML or create a LinearAxis or CategoryAxis object in ActionScript.
Implementation
public function get verticalAxis():IAxis public function set verticalAxis(value:IAxis):voidCartesianDataCanvas | () | Constructor |
public function CartesianDataCanvas()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
addChild | () | method |
override public function addChild(child:DisplayObject):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a child DisplayObject after the end of this child list.
Calling childList.addChild(child) is the same as calling
childList.addChild(child, childList.numChildren)
After it has been added, its index of the new child
will be (child.numChildren - 1)
Parameters
child:DisplayObject — The DisplayObject to add as a child.
|
DisplayObject — The child that was added; this is the same
as the argument passed in.
|
addChildAt | () | method |
override public function addChildAt(child:DisplayObject, index:int):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DisplayObjectContainer object.
If you add a child object that already has a different display object container as a parent, the object is removed from the child list of the other display object container.
Parameters
child:DisplayObject — The DisplayObject instance to add as a child of this
DisplayObjectContainer instance.
| |
index:int — The index position to which the child is added. If you specify a
currently occupied index position, the child object that exists at that position and all
higher positions are moved up one position in the child list.
|
DisplayObject — The DisplayObject instance that you pass in the
child parameter.
|
addDataChild | () | method |
public function addDataChild(child:DisplayObject, left:*, top:*, right:*, bottom:*, hCenter:*, vCenter:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds the specified display object as a child to the current canvas.
Parameters
child:DisplayObject — The display object that is to be added as a child to current canvas.
| |
left:* (default = NaN)child in data coordinates.
| |
top:* (default = NaN)child in data coordinates.
| |
right:* (default = NaN)child in data coordinates.
| |
bottom:* (default = NaN)child in data coordinates.
| |
hCenter:* (default = NaN)child in data coordinates.
| |
vCenter:* (default = NaN)child in data coordinates.
|
beginBitmapFill | () | method |
public function beginBitmapFill(bitmap:BitmapData, x:*, y:*, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Fills a drawing area with a bitmap image. The coordinates that you pass to this method are relative to the canvas's horizontal axis and vertical axis.
The usage and parameters of this method are identical to the beginBitmapFill() method of the
flash.display.Graphics class.
Parameters
bitmap:BitmapData — A transparent or opaque bitmap image that contains the bits to be displayed.
| |
x:* (default = NaN) | |
y:* (default = NaN) | |
matrix:Matrix (default = null) | |
repeat:Boolean (default = true)true, the bitmap image repeats in a tiled pattern.
If false, the bitmap image does not repeat, and the edges of
the bitmap are used for any fill area that extends beyond the bitmap.
| |
smooth:Boolean (default = true)false, upscaled bitmap images are rendered
by using a nearest-neighbor algorithm and look pixelated.
If true, upscaled bitmap images are rendered by using a bilinear algorithm.
Rendering by using the nearest neighbor algorithm is faster.
|
Related API Elements
beginFill | () | method |
public function beginFill(color:uint, alpha:Number = 1):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a simple one-color fill that subsequent calls to other
Graphics methods (such as lineTo() or drawCircle()) use when drawing.
The fill remains in effect until you call the beginFill(),
beginBitmapFill(), beginGradientFill(), or beginShaderFill() method.
Calling the clear() method clears the fill.
The application renders the fill whenever three or more points are drawn, or when
the endFill() method is called.
Note: With the exception of the beginGradientFill() and beginShaderFill() methods, the following information
from the flash.display.Graphics class's beginFill() method applies to this method:
Parameters
color:uint — The color of the fill (0xRRGGBB).
| |
alpha:Number (default = 1) |
Related API Elements
clear | () | method |
public function clear():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
Related API Elements
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.
curveTo | () | method |
public function curveTo(controlX:*, controlY:*, anchorX:*, anchorY:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws a curve using the current line style from the current drawing position to (anchorX, anchorY) and using the control point that (controlX, controlY) specifies. The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
The usage and parameters of this method are identical to the curveTo() method of the
flash.display.Graphics class.
Parameters
controlX:* — The x coordinate of the control point.
| |
controlY:* — The y coordinate of the control point.
| |
anchorX:* — The x coordinate of the anchor point.
| |
anchorY:* — The y coordinate of the anchor point.
|
Related API Elements
dataToLocal | () | method |
override public function dataToLocal(... dataValues):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a tuple of data values to an x-y coordinate on screen. Call this function to transform data on to the screen using the same transform that the individual elements go through. For example, to create a custom highlight for a data region of a chart, you might use this function to determine the on-screen coordinates of the range of interest.
For Cartesian chartelements, you typically pass two values. The first value maps to the horizontal axis, and the second value maps to the vertical axis.
For polar charts, the first value maps to the angular axis, and the second maps to the radial axis.
Parameters
... dataValues — The data values to convert to coordinates.
|
Point — Coordinates that are relative to the chart.
|
describeData | () | method |
override public function describeData(dimension:String, requiredFields:uint):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement.
Implementors fill out and return an Array of
mx.charts.chartClasses.DataDescription objects
to guarantee that their data is correctly accounted for
by any axes that are autogenerating values
from the displayed data (such as minimum, maximum,
interval, and unitSize).
Most element types return an Array
containing a single DataDescription.
Aggregate elements, such as BarSet and ColumnSet,
might return multiple DataDescription instances
that describe the data displayed by their subelements.
When called, the implementor describes the data
along the axis indicated by the dimension argument.
This function might be called for each axis
supported by the containing chart.
Parameters
dimension:String — Determines the axis to get data descriptions of.
| |
requiredFields:uint — A bitfield that indicates which values
of the DataDescription object the particular axis cares about.
Implementors can optimize by only calculating the necessary fields.
|
Array — An Array containing the DataDescription instances that describe
the data that is displayed.
|
drawCircle | () | method |
public function drawCircle(x:*, y:*, radius:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws a circle.
Set the line style, fill, or both before you call the drawCircle() method,
by calling the linestyle(), lineGradientStyle(),
beginFill(), beginGradientFill(), or beginBitmapFill() method.
The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
x:* — The x location of the center of the circle (in pixels).
| |
y:* — The y location of the center of the circle (in pixels).
| |
radius:Number — The radius of the circle (in pixels).
|
Related API Elements
drawEllipse | () | method |
public function drawEllipse(left:*, top:*, right:*, bottom:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws an ellipse.
Set the line style, fill, or both before you call the drawEllipse() method,
by calling the linestyle(), lineGradientStyle(),
beginFill(), beginGradientFill(), or beginBitmapFill() method.
The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
left:* — The x location of the top-left corner of the bounding-box of the ellipse.
| |
top:* — The y location of the top-left corner of the bounding-box of the ellipse.
| |
right:* — The x location of the bottom-right corner of the bounding-box of the ellipse.
| |
bottom:* — The y location of the bottom-right corner of the bounding-box of the ellipse.
|
Related API Elements
drawRect | () | method |
public function drawRect(left:*, top:*, right:*, bottom:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws a rectangle.
Set the line style, fill, or both before you call the drawRect() method,
by calling the linestyle(), lineGradientStyle(),
beginFill(), beginGradientFill(), or beginBitmapFill() method.
The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
left:* — The x location of the top-left corner of the rectangle.
| |
top:* — The y location of the top-left corner of the rectangle.
| |
right:* — The x location of the bottom-right corner of the rectangle.
| |
bottom:* — The y location of the bottom-right corner of the rectangle.
|
Related API Elements
drawRoundedRect | () | method |
public function drawRoundedRect(left:*, top:*, right:*, bottom:*, cornerRadius:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws a rounded rectangle.
Set the line style, fill, or both before you call the drawRoundRect() method,
by calling the linestyle(), lineGradientStyle(),
beginFill(), beginGradientFill(), or beginBitmapFill() method.
The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
left:* — The x location of the top-left corner of the rectangle.
| |
top:* — The y location of the top-left corner of the rectangle.
| |
right:* — The x location of the bottom-right corner of the rectangle.
| |
bottom:* — The y location of the bottom-right corner of the rectangle.
| |
cornerRadius:Number — The radius of the corners, in pixels.
|
Related API Elements
endFill | () | method |
public function endFill():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Applies a fill to the lines and curves that were added since the last call to the
beginFill(), beginGradientFill(), or
beginBitmapFill() method. Flash uses the fill that was specified in the previous
call to the beginFill(), beginGradientFill(), or beginBitmapFill()
method. If the current drawing position does not equal the previous position specified in a
moveTo() method and a fill is defined, the path is closed with a line and then
filled.
Note: With the exception of the beginGradientFill() method, the following information
from the flash.display.Graphics class's endFill() applies to this method:
Related API Elements
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 canvas that the underlying data
in the data provider has changed.
This method triggers calls to the updateMapping()
and updateTransform() methods on the next call
to the commitProperties() method.
Parameters
invalid:Boolean (default = true)true if the data provider's data has changed.
|
invalidateDisplayList | () | method |
override public function invalidateDisplayList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the width and height, it would be wasteful to update the component immediately after you change the width and then update again with the new height. It is more efficient to change both properties and then render the component with its new size once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
lineStyle | () | method |
public function lineStyle(thickness:Number, color:uint = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a line style that Flash uses for subsequent calls to other Graphics methods (such as lineTo()
or drawCircle()) for the object.
The usage and parameters of this method are identical to the lineStyle() method of the
flash.display.Graphics class.
Parameters
thickness:Number — An integer that indicates the thickness of the line in points; valid values are 0-255.
If a number is not specified, or if the parameter is undefined, a line is not drawn.
If a value of less than 0 is passed, the default is 0.
The value 0 indicates hairline thickness; the maximum thickness is 255.
If a value greater than 255 is passed, the default is 255.
| |
color:uint (default = 0) | |
alpha:Number (default = 1.0) | |
pixelHinting:Boolean (default = false)pixelHinting set to true, line widths are adjusted to full pixel widths.
With pixelHinting set to false, disjoints can appear for curves and straight lines.
| |
scaleMode:String (default = "normal")
| |
caps:String (default = null)CapsStyle.NONE, CapsStyle.ROUND,
and CapsStyle.SQUARE. If a value is not indicated, use round caps.
| |
joints:String (default = null)JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND.
If a value is not indicated, use round joints.
| |
miterLimit:Number (default = 3)miterLimit value represents the length that a miter can extend beyond the point at which
the lines meet to form a joint.
The value expresses a factor of the line thickness.
For example, with a miterLimit factor of 2.5 and a thickness of 10 pixels, the miter is cut off at 25 pixels.
|
Related API Elements
lineTo | () | method |
public function lineTo(x:*, y:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws a line using the current line style from the current drawing position to (x, y);
the current drawing position is then set to (x, y).
If the display object in which you are drawing contains content that was created
with the Flash drawing tools, calls to the lineTo() method are drawn underneath the content.
If you call lineTo() before any calls to the moveTo() method, the default position
for the current drawing is (0, 0).
If any of the parameters are missing, this method fails and the current drawing
position is not changed. Coordinates are in terms of data rather than screen coordinates.
The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
x:* — The x coordinate of the drawing position.
| |
y:* — The y coordinate of the drawing position.
|
Related API Elements
localToData | () | method |
override public function localToData(v:Point):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a coordinate on screen to a tuple of data values. Call this function to determine what data values a particular point on-screen represents.
Individual chart types determine how this transformation occurs. The point should be relative to the chart's coordinate space.
Parameters
v:Point — The Point to convert.
|
Array — The tuple of data values.
|
mappingChanged | () | method |
override public function mappingChanged():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the mapping of one or more associated axes changes. The DataTransform assigned to this ChartElement will call this method when any of the axes it represents is modified in some way.
moveTo | () | method |
public function moveTo(x:*, y:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves the current drawing position to (x, y). If any of the parameters are missing, this method fails and the current drawing position is not changed. The coordinates that you pass to this method are in terms of chart data rather than screen coordinates.
Parameters
x:* — The x coordinate of the drawing position.
| |
y:* — The y coordinate of the drawing position.
|
Related API Elements
removeAllChildren | () | method |
public function removeAllChildren():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes all data children (DisplayObject instances) of the canvas.
removeChild | () | method |
override public function removeChild(child:DisplayObject):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes the specified child DisplayObject from this child list.
Removing a child anywhere except from the end of a child list will decrement the indexes of children that were at higher indices.
The removed child will have its parent set to null and will be garbage collected if no other references to it exist.
Parameters
child:DisplayObject — The DisplayObject to remove.
|
DisplayObject — The child that was removed; this is the same
as the argument passed in.
|
removeChildAt | () | method |
override public function removeChildAt(index:int):DisplayObject| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes the child DisplayObject at the specified index from this child list.
Removing a child anywhere except from the end of a child list will decrement the indexes of children that were at higher indices.
The removed child will have its parent set to null and will be garbage collected if no other references to it exist.
Parameters
index:int — The child index of the DisplayObject to remove.
|
DisplayObject — The child that was removed.
|
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 updateFilter()
implementation to remove any ChartItems filtered out by the axes.
Parameters
cache:Array — An array of objects.
| |
field:String — The field property test against.
|
updateDataChild | () | method |
public function updateDataChild(child:DisplayObject, left:*, top:*, right:*, bottom:*, hCenter:*, vCenter:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Updates the position of any child to current canvas.
Parameters
child:DisplayObject — The display object that is to be updated.
| |
left:* (default = NaN) | |
top:* (default = NaN) | |
right:* (default = NaN) | |
bottom:* (default = NaN) | |
hCenter:* (default = NaN) | |
vCenter:* (default = NaN)For example:
var lbl:Label = new Label();
lbl.text = "Last Month";
canvas.addChild(lbl);
canvas.updateDataChild(lbl,"Feb",200);
|
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 canvas 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 canvas 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 CartesianDataCanvas class.
You can generally assume that your updateData()
and updateMapping() 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 updateMapping()
and updateFilter() methods of the canvas, if necessary.
This method is called automatically by the canvas
from the commitProperties() method, as necessary,
but a derived canvas 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():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calls the updateTransform() method of the canvas, if necessary.
This method is called automatically by the canvas
during the commitProperties() method, as necessary,
but a derived canvas 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.
Boolean — Returns true if updateTransform() was called. Otherwise, false.
|
Wed Nov 21 2018, 06:34 AM -08:00