Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CartesianDataCanvas

Package | mx.charts.chartClasses
Class | public class CartesianDataCanvas
Inheritance | CartesianDataCanvas ChartElement DualStyleObject UIComponent FlexSprite flash.display.Sprite
Implements | IDataCanvas

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

This class lets you use add graphical elements such as lines, ellipses, and other shapes by using a graphics API. The values that you pass to the graphics API are in data coordinates rather than screen coordinates. You can also add any DisplaObject to the canvas, in the same way that you add children to containers.

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.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<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 Property `dataChildren`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | 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
|  | 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
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | 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
|  | 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
|  | 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 : 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
|  | 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
|  | 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
|  | 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
|  | 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
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | 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
|  | 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
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | 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
|  | 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 : 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
|  | rotation : Number [override] | 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] | UIComponent
|  | 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
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | 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
|  | 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
|  | 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 : 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
|  | 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] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| 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
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | CartesianDataCanvas() Constructor. | CartesianDataCanvas
|  | addChild(child:DisplayObject):DisplayObject [override] Adds a child DisplayObject after the end of this child list. | CartesianDataCanvas
|  | addChildAt(child:DisplayObject, index:int):DisplayObject [override] Adds a child DisplayObject instance to this DisplayObjectContainer instance. | CartesianDataCanvas
|  | addDataChild(child:DisplayObject, left:*, top:*, right:*, bottom:*, hCenter:*, vCenter:*):void Adds the specified display object as a child to the current canvas. | CartesianDataCanvas
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | beginBitmapFill(bitmap:BitmapData, x:*, y:*, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = true):void Fills a drawing area with a bitmap image. | CartesianDataCanvas
|  | beginFill(color:uint, alpha:Number = 1):void 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
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | chartStateChanged(oldState:uint, v:uint):void Called by the enclosing chart to indicate that the current state of the chart has changed. | ChartElement
|  | claimStyles(styles:Array, firstAvailable:uint):uint Called by the chart to allow associated elements to claim style selectors from its chartSeriesStyles Array. | ChartElement
|  | clear():void | CartesianDataCanvas
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | collectTransitions(chartState:Number, transitions:Array):void Called by the enclosing chart to collect any transitions a particular element might play when the chart changes state. | ChartElement
|  | contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates. | UIComponent
|  | contentToLocal(point:Point):Point Converts a Point object from content to local coordinates. | UIComponent
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | curveTo(controlX:*, controlY:*, anchorX:*, anchorY:*):void 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
|  | dataToLocal(... dataValues):Point [override] Converts a tuple of data values to an x-y coordinate on screen. | CartesianDataCanvas
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | describeData(dimension:String, requiredFields:uint):Array [override] Called by the governing DataTransform to obtain a description of the data represented by this IChartElement. | CartesianDataCanvas
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawCircle(x:*, y:*, radius:Number):void Draws a circle. | CartesianDataCanvas
|  | drawEllipse(left:*, top:*, right:*, bottom:*):void Draws an ellipse. | CartesianDataCanvas
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRect(left:*, top:*, right:*, bottom:*):void Draws a rectangle. | CartesianDataCanvas
|  | drawRoundedRect(left:*, top:*, right:*, bottom:*, cornerRadius:Number):void 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
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | endFill():void Note: With the exception of the beginGradientFill() method, the following information from the flash.display.Graphics class's endFill() applies to this method: | CartesianDataCanvas
|  | executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination. | UIComponent
|  | findDataPoints(x:Number, y:Number, sensitivity2:Number):Array Finds the closest data point represented by the element under the given coordinates. | ChartElement
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAllDataPoints():Array 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
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | getRepeaterItem(whichRepeater:int = -1):Object 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
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | globalToContent(point:Point):Point Converts a Point object from global to content coordinates. | UIComponent
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void [override] Marks a component so that its updateDisplayList() method gets called during a later screen update. | CartesianDataCanvas
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | 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
|  | lineTo(x:*, y:*):void 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
|  | localToContent(point:Point):Point Converts a Point object from local to content coordinates. | UIComponent
|  | localToData(v:Point):Array [override] Converts a coordinate on screen to a tuple of data values. | CartesianDataCanvas
|  | mappingChanged():void [override] Called when the mapping of one or more associated axes changes. | CartesianDataCanvas
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | measureHTMLText(htmlText:String):TextLineMetrics 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
|  | measureText(text:String):TextLineMetrics 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
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | moveTo(x:*, y:*):void Moves the current drawing position to (x, y). | CartesianDataCanvas
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void 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
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeAllChildren():void Removes all data children (DisplayObject instances) of the canvas. | CartesianDataCanvas
|  | removeChild(child:DisplayObject):DisplayObject [override] Removes the specified child DisplayObject from this child list. | CartesianDataCanvas
|  | removeChildAt(index:int):DisplayObject [override] Removes the child DisplayObject at the specified index from this child list. | CartesianDataCanvas
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | toString():String [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
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void 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
|  | updateDataChild(child:DisplayObject, left:*, top:*, right:*, bottom:*, hCenter:*, vCenter:*):void Updates the position of any child to current canvas. | CartesianDataCanvas
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void 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
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addMXMLChildren(comps:Array):void | UIComponent
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform. | UIComponent
|  | attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect. | UIComponent
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | commitProperties():void [override] Processes the properties set on the component. | CartesianDataCanvas
|  | createChildren():void Create child objects of the component. | UIComponent
|  | createDataID(dataPointID:Number):Number Creates a unique id to represent the dataPoint for comparison purposes. | ChartElement
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | dataChanged():void Indicates the underlying data represented by the element has changed. | ChartElement
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | invalidateData(invalid:Boolean = true):void Informs the canvas that the underlying data in the data provider has changed. | CartesianDataCanvas
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | measure():void Calculates the default size, and optionally the default minimum size, of the component. | UIComponent
|  | processNewDataProvider(value:Object):void Called when a new dataProvider is assigned to the element. | ChartElement
|  | resourcesChanged():void 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
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component. | UIComponent
|  | stripNaNs(cache:Array, field:String):void Removes any item from the provided cache whose field property is NaN. | CartesianDataCanvas
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Draws the object and/or sizes and positions its children. | CartesianDataCanvas
|  | updateFilter():void 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
|  | validateData():void Calls the updateMapping() and updateFilter() methods of the canvas, if necessary. | CartesianDataCanvas
|  | validateTransform():Boolean Calls the updateTransform() method of the canvas, if necessary. | CartesianDataCanvas

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dragComplete | Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent
|  | dragDrop | Dispatched by the drop target when the user releases the mouse over it. | UIComponent
|  | dragEnter | Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent
|  | dragExit | Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent
|  | dragOver | Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | bottom | Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | focusBlendMode | Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | focusThickness | Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent
|  | horizontalCenter | Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | left | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | right | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | top | Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | verticalCenter | Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | Triggering Event: added Played when the component is added as a child to a Container. | UIComponent
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | focusInEffect | Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent
|  | focusOutEffect | Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | moveEffect | Triggering Event: move Played when the component is moved. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent

Property Detail

dataChildren | property

`dataChildren:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An array of child objects.

Implementation
`public function get dataChildren():Array`
`public function set dataChildren(value:Array):void`

dataTransform | property |

`dataTransform: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
`public function get dataTransform():DataTransform`
`public function set dataTransform(value:DataTransform):void`

horizontalAxis | 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):void`

includeInRanges | 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):void`

verticalAxis | 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):void`
Constructor Detail

CartesianDataCanvas | () | Constructor

`public function CartesianDataCanvas()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

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.

Returns

| `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.

Returns

| `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`)`` — Left x-coordinate of the `child` in data coordinates.
| `top:*` (default = `NaN`)`` — Top y-coordinate of the `child` in data coordinates.
| `right:*` (default = `NaN`)`` — Right x-coordinate of the `child` in data coordinates.
| `bottom:*` (default = `NaN`)`` — Bottom y-coordinate of the `child` in data coordinates.
| `hCenter:*` (default = `NaN`)`` — Middle x-coordinate of the `child` in data coordinates.
| `vCenter:*` (default = `NaN`)`` — Middle y-coordinate of the `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`)`` — The x coordinate of the fill.
| `y:*` (default = `NaN`)`` — The y coordinate of the fill.
| `matrix:Matrix` (default = `null`)`` — A matrix object (of the flash.geom.Matrix class), which you can use to define transformations on the bitmap.
| `repeat:Boolean` (default = `true`)`` — If `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`)`` — If `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.

See also

flash.display.Graphics.beginBitmapFill()

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

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`
| `alpha:Number` (default = `1`)``

See also

flash.display.Graphics

clear | () | method |

`public function clear():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

See also

flash.display.Graphics

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.

See also

flash.display.Graphics.curveTo()

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.

Returns

| `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.

Returns

| `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).

See also

flash.display.Graphics

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.

See also

flash.display.Graphics.drawEllipse()

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.

See also

flash.display.Graphics.drawRect()

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.

See also

flash.display.Graphics.drawRoundRect()

endFill | () | method |

`public function endFill():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Note: With the exception of the `beginGradientFill()` method, the following information from the `flash.display.Graphics` class's `endFill()` applies to this method:

See also

flash.display.Graphics

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`)`` — A hexadecimal color value of the line; for example, red is 0xFF0000, blue is 0x0000FF, and so on. If a value is not indicated, the default is 0x000000 (black).
| `alpha:Number` (default = `1.0`)`` — A number that indicates the alpha value of the color of the line; valid values are 0 to 1. If a value is not indicated, the default is 1 (solid). If the value is less than 0, the default is 0. If the value is greater than 1, the default is 1.
| `pixelHinting:Boolean` (default = `false`)`` — A Boolean value that specifies whether to hint strokes to full pixels. This affects both the position of anchors of a curve and the line stroke size itself. With `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`)`` — A value from the flash.display.LineScaleMode class that specifies which scale mode to use: `LineScaleMode.NORMAL`: Always scale the line thickness when the object is scaled (the default). `LineScaleMode.NONE`: Never scale the line thickness. `LineScaleMode.VERTICAL`: Do not scale the line thickness if the object is scaled vertically only. `LineScaleMode.HORIZONTAL`: Do not scale the line thickness if the object is scaled horizontally only.
| `caps:String` (default = `null`)`` — A value from the flash.display.CapsStyle class that specifies the type of caps at the end of lines. Valid values are: `CapsStyle.NONE`, `CapsStyle.ROUND`, and `CapsStyle.SQUARE`. If a value is not indicated, use round caps.
| `joints:String` (default = `null`)`` — A value from the flash.display.JointStyle class that specifies the type of joint appearance used at angles. Valid values are: `JointStyle.BEVEL`, `JointStyle.MITER`, and `JointStyle.ROUND`. If a value is not indicated, use round joints.
| `miterLimit:Number` (default = `3`)`` — A number that indicates the limit at which a miter is cut off. Valid values range from 1 to 255 (and values outside that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The `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.

See also

flash.display.Graphics.lineStyle()

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.

See also

flash.display.Graphics.lineTo()

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.

Returns

| `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.

See also

flash.display.Graphics.moveTo()

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.

Returns

| `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.

Returns

| `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`)`` — Left x coordinate of the child, in data coordinates.
| `top:*` (default = `NaN`)`` — Top y coordinate of the child, in data coordinates.
| `right:*` (default = `NaN`)`` — Right x coordinate of the child, in data coordinates.
| `bottom:*` (default = `NaN`)`` — Bottom y coordinate of the child, in data coordinates.
| `hCenter:*` (default = `NaN`)`` — Middle x coordinate of the child, in data coordinates.
| `vCenter:*` (default = `NaN`)`` — Middle y coordinate of the child, in data coordinates. 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.

Returns

| `Boolean` — Returns `true` if `updateTransform()` was called. Otherwise, `false`.

Sun Mar 5 2017, 03:42 PM +11:00