| Package | mx.charts.series |
| Class | public class ColumnSet |
| Inheritance | ColumnSet  StackedSeries Series ChartElement DualStyleObject UIComponent FlexSprite flash.display.Sprite |
| Implements | IColumn |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Default MXML Propertyseries
| 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 | |
| allowNegativeForStacked : Boolean
Setting this property to true will stack positive
and negative values separately
| StackedSeries | |
| 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 | |
| columnWidthRatio : Number
Specifies the width of columns relative to the category width. | ColumnSet | ||
| 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 | |
| dataFunction : Function
Specifies a method that returns the value that should be used for
positioning the current chart item in the series. | Series | |
| dataProvider : Object
A data provider assigned to the this specific element. | ChartElement | |
| dataTipItems : Array
Array of chart items for which data tips are to be shown
non-interactively on the chart. | Series | |
| dataTransform : DataTransform [override]
The DataTransform object that the element is associated with. | Series | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| displayName : String
The name of the series, for display to the user. | Series | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filterData : Boolean
If filterFuction or filterDataValues is set,
filterData is ignored. | Series | |
| filterDataValues : String
If filterFuction is set, filterDataValues and
filterData are ignored. | Series | |
| filterFunction : Function
Specifies a method that returns the array of chart items in the series
that are to be displayed. | Series | |
| 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. | StackedSeries | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| interactive : Boolean
Determines whether data tips appear when users interact
with chart data on the screen. | Series | |
| internalStyleName : Object
The name of a class selector this instance inherits values from. | DualStyleObject | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| items : Array [read-only]
Gets all the items that are there in the series after filtering. | Series | |
| labelContainer : Sprite [read-only]
The DisplayObject that displays labels rendered by this element. | ChartElement | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| legendData : Array [read-only]
An Array of LegendData instances that describe the items
that should show up in a legend representing this series. | Series | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxColumnWidth : Number
Specifies the width of the columns, in pixels. | ColumnSet | ||
| 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 | |
| offset : Number
Specifies how far to offset the center of the columns from the center of the available space, relative to the category width. | ColumnSet | ||
| 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 | |
| selectable : Boolean
Specifies whether a series is selectable or not. | Series | |
| selectedIndex : int
Index of the selected item in the data provider of the series. | Series | |
| selectedIndices : Array
An Array of indexes of the selected items in the data provider of the series. | Series | |
| selectedItem : ChartItem
The chart item that is selected in the series. | Series | |
| selectedItems : Array
An Array of chart items that are selected in the series. | Series | |
| series : Array
An array of sub-series managed by this stacking set. | StackedSeries | |
| 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 | |
| transitionRenderData : Object
A render data structure passed in by a running transtion. | Series | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| type : String
The grouping behavior of this series. | StackedSeries | |
| 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. | StackedSeries | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ColumnSet | ||
| addChild(child:DisplayObject):DisplayObject [override]
Adds a child DisplayObject after the end of this child list. | ChartElement | |
| addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | ChartElement | |
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| beginInterpolation(sourceRenderData:Object, destRenderData:Object):Object
Called by the SeriesInterpolate effect to initiate an interpolation effect. | Series | |
| 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 [override]
Called by the chart to allow associated elements
to claim style selectors from its chartSeriesStyles Array. | Series | |
| 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 | |
| dataToLocal(... dataValues):Point
Converts a tuple of data values to an x-y coordinate on screen. | ChartElement | |
| 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. | ColumnSet | ||
|
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 | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| 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 | |
| endInterpolation(interpolationData:Object):void
Called by the SeriesInterpolate effect to end an interpolation effect. | Series | |
| 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 | |
|
You typically retrieve the Axis instance directly through a named property
(such as for a Cartesian-based series horizontalAxis, verticalAxis,
or radiusAxis). | Series | |
| 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 | |
| getElementBounds(renderData:Object):void
Fills in the elementBounds, bounds,
and visibleBounds properties of a renderData
structure that is generated by this series. | Series | |
| 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 | |
| getItemsInRegion(r:Rectangle):Array
Gets all the items that are in a rectangular region for the series. | Series | |
| 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 | |
| getRenderDataForTransition(type:String):Object
Captures the before and after states of the series for animation. | Series | |
| 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 | |
| interpolate(interpolationValues:Array, interpolationData:Object):void
Called by the SeriesInterpolate effect to advance an interpolation. | Series | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| 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 | |
| invalidateStacking():void
Call this method to trigger a regeneration of the stacked values
on the next call to the commitProperties() method. | StackedSeries | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| localToData(pt:Point):Array
Converts a coordinate on screen to a tuple of data values. | ChartElement | |
| mappingChanged():void
Called when the mapping of one or more associated axes changes. | ChartElement | |
| 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 | |
| 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 | |
| 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 [override]
Sets the actual size of this object. | Series | |
|
Assigns an Axis instance to a particular dimension of the chart. | Series | |
| 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 | |
| stack():void
Updates the series data, and uses the values of the series data
it is stacking on top of so it can stack correctly. | StackedSeries | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void [override]
Calls the legendDataChanged() method. | Series | |
| 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 | |
| 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 | |
| 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 | |
buildSubSeries():void [override]
Processes the Array of sub-series for display, when necessary. | ColumnSet | ||
| cacheDefaultValues(measureName:String, cache:Array, fieldName:String):Boolean
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | |
| cacheIndexValues(measureName:String, cache:Array, fieldName:String):Boolean
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | |
| cacheNamedValues(measureName:String, cache:Array, fieldName:String):Boolean
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | |
| 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. | Series | |
| 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 | |
customizeSeries(glyph:IChartElement, i:uint):void [override]
Applies any customization to a sub-series
when building the stacking behavior. | ColumnSet | ||
| dataChanged():void
Indicates the underlying data represented by the element has changed. | ChartElement | |
| defaultFilterFunction(cache:Array):Array
This is used if you do not set a custom function as the filterFunction for the series. | Series | |
| dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
| dragStartHandler(event:DragEvent):void
The default handler for the dragStart event. | Series | |
| extractMinInterval(cache:Array, measureName:String, desc:DataDescription):void
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | |
| extractMinMax(cache:Array, measureName:String, desc:DataDescription, calculateInterval:Boolean = false):void
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | |
| 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 | |
formatDataTip(hd:HitData):String [override]
Provides custom text for DataTip objects. | ColumnSet | ||
| generateMXMLAttributes(data:Array):void | UIComponent | |
| generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | |
| generateMXMLObject(document:Object, data:Array):Object | UIComponent | |
| getMissingInterpolationValues(sourceProps:Object, srcCache:Array, destProps:Object, destCache:Array, index:Number, customData:Object):void
Fills in missing values in an interpolation structure. | Series | |
| 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 | |
| initializeInterpolationData(srcCache:Array, dstCache:Array, iProps:Object, cacheType:Class = null, customData:Object = null):Object
Helper method to implement the interpolation effect. | Series | |
| invalidateData(invalid:Boolean = true):void
Informs the series that the underlying data
in the data provider has changed. | Series | |
| invalidateFilter(invalid:Boolean = true):void
Informs the series that the filter of the data against the axes
has changed and must be recalculated. | Series | |
| invalidateMapping(invalid:Boolean = true):void
Informs the series that the mapping of the data into numeric values
has changed and must be recalculated. | Series | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
| invalidateSeries():void
Call this method to trigger a call to the buildSubSeries()
method on the next call to the commitProperties() method. | StackedSeries | |
| invalidateTransform(invalid:Boolean = true):void
Informs the series that the transform of the data to screen coordinates
has changed and must be recalculated. | Series | |
| invalidateTransitions():void
Informs the series that a significant change has occured
in the display of data. | Series | |
| 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 | |
| legendDataChanged():void
Updates the Legend items when the series display name changes
by dispatching a new LegendDataChanged event. | Series | |
| 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. | Series | |
| updateData():void
Called when the underlying data that the series represents
has changed and needs to be reloaded from the data provider. | Series | |
| updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Draws the object and/or sizes and positions its children. | Series | |
| updateFilter():void
Called when the underlying data the series represents
needs to be filtered against the ranges represented by the axes
of the associated data transform. | Series | |
| updateMapping():void
Called when the underlying data the series represents
needs to be mapped to numeric representations. | Series | |
| updateStacking():void
Iterates over the individual sub-series to build the stacked values. | StackedSeries | |
| updateTransform():void
Called when the underlying data the series represents
needs to be transformed from data to screen values
by the axes of the associated data transform. | Series | |
| validateData():void
Calls the updateData() and
updateMapping() methods of the series, if necessary. | Series | |
| validateTransform():void
Calls the updateFilter() and
updateTransform() methods of the series, if necessary. | Series | |
| columnWidthRatio | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescolumnWidthRatio:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies the width of columns relative to the category width. A value of 1 uses the entire space, while a value of .6
uses 60% of the column's available space.
You typically do not set this property directly.
The actual column width used is the smaller of columnWidthRatio and the maxColumnWidth property
The default value is 0.65.
public function get columnWidthRatio():Number public function set columnWidthRatio(value:Number):void| maxColumnWidth | property |
maxColumnWidth:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies the width of the columns, in pixels. The actual column width used is the smaller of this style and the columnWidthRatio property.
Clustered columns divide this space proportionally among the columns in each cluster.
public function get maxColumnWidth():Number public function set maxColumnWidth(value:Number):void| offset | property |
offset:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies how far to offset the center of the columns from the center of the available space, relative to the category width.
At the value of default 0, the columns are centered on the space.
Set to -50 to center the column at the beginning of the available space.
You typically do not set this property directly. The ColumnChart control manages this value based on
its columnWidthRatio property.
public function get offset():Number public function set offset(value:Number):void| ColumnSet | () | Constructor |
public function ColumnSet()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
| buildSubSeries | () | method |
override protected function buildSubSeries():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Processes the Array of sub-series for display, when necessary. This method ensures that all sub-series are added as children of this stacking set, and applies any per-series customization that is necessary (for example, assigning inherited data providers or clustering properties).
This method is also responsible for informing the chart that series
have changed and, as a result, implicit series styles must be reassigned.
This method is called automatically by the stacking set, when necessary.
Instead of calling this method directly,
you should consider calling the invalidateSeries() method.
| customizeSeries | () | method |
override protected function customizeSeries(glyph:IChartElement, i:uint):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Applies any customization to a sub-series when building the stacking behavior. By default, this method assigns the inherited data providers to the sub-series. Derived classes can override this method to apply further customization.
Parameters
glyph:IChartElement — The chart element to customize.
| |
i:uint — The sub-series' position in the series array.
|
| 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.
|
| formatDataTip | () | method |
override protected function formatDataTip(hd:HitData):String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Provides custom text for DataTip objects. Stacking sets override the DataTip text of their contained sub-series to display additional information related to the stacking behavior. Derived classes must override this method to define custom DataTip text.
Parameters
hd:HitData — The hitData object in the stack.
|
String — The custom text for the DataTip. The default is the empty string. You must
override this method to provide a custom DataTip.
|