Package | mx.charts.series |
Class | public class BarSeries |
Inheritance | BarSeries Series ChartElement DualStyleObject UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Implements | IStackable2, IBar |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The <mx:BarSeries>
tag inherits all the properties
of its parent classes and adds the following properties:
<mx:BarSeries Properties barWidthRatio=".65" fillFunction="Internal fill function" horizontalAxis="No default" labelField="No default" labelFunction="No default" maxBarWidth="No default" minField="null" offset="No default" stacker="No default" stackTotals="No default" verticalAxis="No default" xField="null" yField="null" Styles fill="IFill; no default" fills="IFill; no default" fontFamily="Verdana" fontSize="10" fontStyle="italic|normal" fontWeight="bold|normal" labelAlign="center|left|right" labelPosition="none|inside|outside" labelSizeLimit="9" itemRenderer="itemRenderer" legendMarkerRenderer="Defaults to series's itemRenderer" stroke="IStroke; no default" textDecoration="underline|none" />
More examples
Using bar charts
Applying different styles to each series
Using fills with chart controls
Using filters with chart controls
Adding data labels
Styling data labels
Customizing data labels for ColumnSeries and BarSeries objects
Using the minField property
Learn more
About the series classes
Using multiple data series
Using multiple axes
Applying chart styles
Using data labels
Customizing data label values
Using DataTip objects
Using per-item fills
Stacking charts
Related API Elements
Property | Defined By | ||
---|---|---|---|
accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | ||
accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | ||
automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | ||
automationName : String
Name that can be used as an identifier for this object. | UIComponent | ||
automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | ||
automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | ||
automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | ||
automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | ||
barWidthRatio : Number
Specifies how wide to render the bars relative to the category width. | BarSeries | ||
baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | ||
blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | ||
bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | ||
cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | ||
chartDataProvider : Object [write-only]
The data provider assigned to the enclosing chart. | ChartElement | ||
className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | ||
contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | ||
contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | ||
currentState : String
The current view state of the component. | UIComponent | ||
cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | ||
dataFunction : Function
Specifies a method that returns the value that should be used for
positioning the current chart item in the series. | Series | ||
dataProvider : Object
A data provider assigned to the this specific element. | ChartElement | ||
dataTipItems : Array
Array of chart items for which data tips are to be shown
non-interactively on the chart. | Series | ||
dataTransform : mx.charts.chartClasses:DataTransform [override]
The DataTransform object that the element is associated with. | Series | ||
depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | ||
displayName : String
The name of the series, for display to the user. | Series | ||
document : Object
A reference to the document object associated with this UIComponent. | UIComponent | ||
doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | ||
dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | ||
enabled : Boolean
Whether the component can accept user interaction. | UIComponent | ||
errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | ||
explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | ||
fillFunction : Function
Specifies a method that returns the fill for the current chart item in the series. | BarSeries | ||
filterData : Boolean
If filterFuction or filterDataValues is set,
filterData is ignored. | Series | ||
filterDataValues : String
If filterFuction is set, filterDataValues and
filterData are ignored. | Series | ||
filterFunction : Function
Specifies a method that returns the array of chart items in the series
that are to be displayed. | Series | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | ||
focusPane : Sprite
The focus pane associated with this object. | UIComponent | ||
focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | ||
graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | ||
hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | ||
hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | ||
height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | ||
hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | ||
horizontalAxis : IAxis
Defines the labels, tick marks, and data position
for items on the x-axis. | BarSeries | ||
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 [override] [read-only]
Gets all the items that are there in the series after filtering. | BarSeries | ||
labelContainer : Sprite [read-only]
The DisplayObject that displays labels rendered by this element. | ChartElement | ||
labelField : String
Name of a field in the data provider whose value appears as the label. | BarSeries | ||
labelFunction : Function
Specifies a callback function used to render each label
of the Series. | BarSeries | ||
layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | ||
left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
legendData : Array [read-only]
An Array of LegendData instances that describe the items
that should show up in a legend representing this series. | Series | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | ||
maxBarWidth : Number
Specifies the width of the bars, in pixels. | BarSeries | ||
maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels. | UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels. | UIComponent | ||
metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | ||
minField : String
Specifies the field of the data provider that determines the bottom of each bar. | BarSeries | ||
minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
moduleFactory : IFlexModuleFactory [override]
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | BarSeries | ||
mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | ||
mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | DisplayObject | ||
needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | ||
nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | ||
numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | ||
numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | ||
offset : Number
Specifies how far to offset the center of the bars from the center of the available space, relative the category width. | BarSeries | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | ||
owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | ||
parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | ||
parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | ||
parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | ||
percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | ||
percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | ||
postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | ||
processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | ||
repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | ||
right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | ||
rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | ||
rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | ||
scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | ||
scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | ||
scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | ||
screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | ||
selectable : Boolean
Specifies whether a series is selectable or not. | Series | ||
selectedIndex : int
Index of the selected item in the data provider of the series. | Series | ||
selectedIndices : Array
An Array of indexes of the selected items in the data provider of the series. | Series | ||
selectedItem : ChartItem
The chart item that is selected in the series. | Series | ||
selectedItems : Array
An Array of chart items that are selected in the series. | Series | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | ||
softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | ||
softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
stacker : StackedSeries
The StackedSeries associated with this BarSeries. | BarSeries | ||
stackTotals : Dictionary [write-only]
The stack totals for the series. | BarSeries | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
states : Array
The view states that are defined for this component. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | ||
styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | ||
styleName : Object
The class style used by this component. | UIComponent | ||
styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | ||
tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | ||
tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | ||
tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | ||
tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | ||
textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | ||
toolTip : String
Text to display in the ToolTip. | UIComponent | ||
top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | ||
transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | ||
transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | ||
transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | ||
transitionRenderData : Object
A render data structure passed in by a running transtion. | Series | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | ||
uid : String
A unique identifier for the object. | UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | ||
useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | ||
validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | ||
verticalAxis : IAxis
Defines the labels, tick marks, and data position
for items on the y-axis. | BarSeries | ||
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 | ||
xField : String
Specifies the field of the data provider that determines the x-axis location of the top of each bar. | BarSeries | ||
y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | ||
yField : String
Specifies the field of the data provider that determines the y-axis location of the bottom of each bar in the chart. | BarSeries | ||
z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent |
Property | Defined By | ||
---|---|---|---|
chart : ChartBase [read-only]
Refers to the chart component containing this element. | ChartElement | ||
currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | ||
cursor : IViewCursor
Each ChartElement carries a cursor associated with their dataProvider
for their own internal use. | ChartElement | ||
hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | ||
itemType : Class [read-only]
The subtype of ChartItem used by this series to represent individual items. | BarSeries | ||
renderData : Object [read-only]
Stores the information necessary to render this series. | Series | ||
renderDataType : Class [read-only]
The subtype of ChartRenderData used by this series to store all data necessary to render. | BarSeries | ||
resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | ||
unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | ||
unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent |
Method | Defined By | ||
---|---|---|---|
Constructor. | BarSeries | ||
[override]
Adds a child DisplayObject after the end of this child list. | ChartElement | ||
[override]
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | ChartElement | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Adds a non-visual style client to this component instance. | UIComponent | ||
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | ||
Called by the SeriesInterpolate effect to initiate an interpolation effect. | Series | ||
Queues a function to be called later. | UIComponent | ||
Called by the enclosing chart to indicate that the current state
of the chart has changed. | ChartElement | ||
[override]
Called by the chart to allow associated elements
to claim style selectors from its chartSeriesStyles Array. | Series | ||
Deletes a style property from this component instance. | UIComponent | ||
Called by the enclosing chart to collect any transitions
a particular element might play when the chart changes state. | ChartElement | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Converts a Point object from content coordinates to global coordinates. | UIComponent | ||
Converts a Point object from content to local coordinates. | UIComponent | ||
Returns a set of properties that identify the child within
this container. | UIComponent | ||
Returns a set of properties that identify the child within
this container. | UIComponent | ||
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Converts a tuple of data values to an x-y coordinate on screen. | ChartElement | ||
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement. | ChartElement | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | ||
[override]
Dispatches an event into the event flow. | UIComponent | ||
Shows or hides the focus indicator around this component. | UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | ||
Called by the effect instance when it stops playing on the component. | UIComponent | ||
Called by the effect instance when it starts playing on the component. | UIComponent | ||
Ends all currently playing effects on the component. | UIComponent | ||
Called by the SeriesInterpolate effect to end an interpolation effect. | Series | ||
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
Finds the closest data point represented by the element
under the given coordinates. | ChartElement | ||
Called after printing is complete. | UIComponent | ||
Returns an array of HitData of the items of all the underlying
ChartElements whose dataTips are to be shown when
showAllDataTips is set to true on
chart
| ChartElement | ||
Provides the automation object at the specified index. | UIComponent | ||
Provides the automation object list . | UIComponent | ||
You typically retrieve the Axis instance directly through a named property
(such as for a Cartesian-based series horizontalAxis, verticalAxis,
or radiusAxis). | Series | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | ||
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | ||
Finds the type selectors for this UIComponent instance. | UIComponent | ||
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
Fills in the elementBounds, bounds,
and visibleBounds properties of a renderData
structure that is generated by this series. | Series | ||
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
Gets the object that currently has focus. | UIComponent | ||
Gets all the items that are in a rectangular region for the series. | Series | ||
Returns the element's layout height. | UIComponent | ||
Returns the element's layout width. | UIComponent | ||
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
Returns the layout transform Matrix3D for this element. | UIComponent | ||
Returns the element's maximum height. | UIComponent | ||
Returns the element's maximum width. | UIComponent | ||
Returns the element's minimum height. | UIComponent | ||
Returns the element's minimum width. | UIComponent | ||
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | ||
Returns the element's preferred height. | UIComponent | ||
Returns the element's preferred width. | UIComponent | ||
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | ||
Captures the before and after states of the series for animation. | Series | ||
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
Converts a Point object from global to content coordinates. | UIComponent | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | ||
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | ||
Returns true if currentCSSState is not null. | UIComponent | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | ||
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
Initializes the internal structure of this component. | UIComponent | ||
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
Called by the SeriesInterpolate effect to advance an interpolation. | Series | ||
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | ||
Converts a Point object from local to content coordinates. | UIComponent | ||
Converts a coordinate on screen to a tuple of data values. | ChartElement | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | ||
Called when the mapping of one or more associated axes changes. | ChartElement | ||
Returns true if cssState matches currentCSSState. | UIComponent | ||
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
Moves the component to a specified position within its parent. | UIComponent | ||
Propagates style changes to the children. | UIComponent | ||
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | ||
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | ||
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | ||
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | ||
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Removes a non-visual style client from this component instance. | UIComponent | ||
Replays the specified event. | UIComponent | ||
Raises a virtual keyboard. | InteractiveObject | ||
Resolves a child by using the id provided. | UIComponent | ||
[static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
[override]
Sets the actual size of this object. | Series | ||
Assigns an Axis instance to a particular dimension of the chart. | Series | ||
Changes the position of an existing child in the display object container. | DisplayObjectContainer | ||
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
Set the current state. | UIComponent | ||
Sets the focus to this component. | UIComponent | ||
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
Sets the layout size of the element. | UIComponent | ||
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Sets a style property on this component instance. | UIComponent | ||
Called when the visible property changes. | UIComponent | ||
Stacks the series. | BarSeries | ||
stackAll(stackedPosYValueDictionary:Dictionary, stackedNegYValueDictionary:Dictionary, previousElement:IStackable2):Object
Stacks the series. | BarSeries | ||
Lets the user drag the specified sprite. | Sprite | ||
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | ||
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | ||
Ends the startDrag() method. | Sprite | ||
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | ||
Detects changes to style properties. | UIComponent | ||
[override]
Calls the legendDataChanged() method. | Series | ||
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | ||
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | ||
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | ||
Validates the position and size of children and draws other
visuals. | UIComponent | ||
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
Returns the primitive value of the specified object. | Object | ||
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Method | Defined By | ||
---|---|---|---|
Adjust the focus rectangle. | UIComponent | ||
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | ||
Customizes the item renderer instances that are used to represent the chart. | BarSeries | ||
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Caches the values stored in the measureName property
from the original dataProvider items in the chart item's
fieldName property. | Series | ||
Determines if the call to the measure() method can be skipped. | UIComponent | ||
Performs any final processing after child objects are created. | UIComponent | ||
[override]
Processes the properties set on the component. | BarSeries | ||
[override]
Create child objects of the component. | BarSeries | ||
Creates a unique id to represent the dataPoint
for comparison purposes. | ChartElement | ||
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
Creates the object using a given moduleFactory. | UIComponent | ||
Indicates the underlying data represented by the element has changed. | ChartElement | ||
This is used if you do not set a custom function as the filterFunction for the series. | Series | ||
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
The default handler for the dragStart event. | Series | ||
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | ||
extractMinMax(cache:Array, measureName:String, desc:DataDescription, calculateInterval:Boolean = false):void
Extracts the minimum value, maximum value, and, optionally,
the minimum interval from an Array of ChartItem objects. | Series | ||
The event handler called when a UIComponent object gets focus. | UIComponent | ||
The event handler called when a UIComponent object loses focus. | UIComponent | ||
getMissingInterpolationValues(sourceProps:Object, srcCache:Array, destProps:Object, destCache:Array, index:Number, customData:Object):void
Fills in missing values in an interpolation structure. | Series | ||
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | ||
Finalizes the initialization of this component. | UIComponent | ||
Initializes this component's accessibility code. | UIComponent | ||
initializeInterpolationData(srcCache:Array, dstCache:Array, iProps:Object, cacheType:Class = null, customData:Object = null):Object
Helper method to implement the interpolation effect. | Series | ||
[override]
Informs the series that the underlying data
in the data provider has changed. | BarSeries | ||
Informs the series that the filter of the data against the axes
has changed and must be recalculated. | Series | ||
[override]
Informs the series that the mapping of the data into numeric values
has changed and must be recalculated. | BarSeries | ||
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | ||
Informs the series that the transform of the data to screen coordinates
has changed and must be recalculated. | Series | ||
Informs the series that a significant change has occured
in the display of data. | Series | ||
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | ||
The event handler called for a keyDown event. | UIComponent | ||
The event handler called for a keyUp event. | UIComponent | ||
Updates the Legend items when the series display name changes
by dispatching a new LegendDataChanged event. | Series | ||
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | ||
Called when a new dataProvider is assigned to the element. | ChartElement | ||
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | ||
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | ||
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | ||
Removes any item from the provided cache whose field
property is NaN. | Series | ||
Called when the underlying data that the series represents
has changed and needs to be reloaded from the data provider. | Series | ||
[override]
Draws the object and/or sizes and positions its children. | Series | ||
Called when the underlying data the series represents
needs to be filtered against the ranges represented by the axes
of the associated data transform. | Series | ||
Called when the underlying data the series represents
needs to be mapped to numeric representations. | Series | ||
Called when the underlying data the series represents
needs to be transformed from data to screen values
by the axes of the associated data transform. | Series | ||
Calls the updateData() and
updateMapping() methods of the series, if necessary. | Series | ||
Calls the updateFilter() and
updateTransform() methods of the series, if necessary. | Series |
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Style | Description | Defined By | ||
---|---|---|---|---|
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | |||
color | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label. The default value is 0x0B333C . | BarSeries | ||
disabledColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled. The default value is 0xAAB3B3 . | BarSeries | ||
Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | |||
fill | Type: mx.graphics.IFill CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the fill for this data series. You can specify either an object implementing the IFill interface, or a number representing a solid color value. You can also specify a solid fill using CSS. | BarSeries | ||
fills | Type: Array CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies an Array of fill objects that define the fill for each item in the series. This takes precedence over the fill style property.
If a custom method is specified by the fillFunction property, that takes precedence over this Array.
If you do not provide enough Array elements for every item,
Flex repeats the fill from the beginning of the Array.
To set the value of this property using CSS: BarSeries { fills:#CC66FF, #9966CC, #9999CC; } To set the value of this property using MXML: <mx:BarSeries ... > <mx:fills> <mx:SolidColor color="0xCC66FF"/> <mx:SolidColor color="0x9966CC"/> <mx:SolidColor color="0x9999CC"/> </mx:fills> </mx:BarSeries>
If you specify the | BarSeries | ||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Blend mode used by the focus rectangle. | UIComponent | |||
Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | |||
Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Thickness, in pixels, of the focus rectangle outline. | UIComponent | |||
fontAntiAliasType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL )
and "advanced" (flash.text.AntiAliasType.ADVANCED ).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is "advanced" .Related API Elements | BarSeries | ||
fontFamily | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana" . | BarSeries | ||
fontGridFitType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE ),
"pixel" (flash.text.GridFitType.PIXEL ),
and "subpixel" (flash.text.GridFitType.SUBPIXEL ).
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is "pixel" .Related API Elements | BarSeries | ||
fontSharpness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0 .Related API Elements | BarSeries | ||
fontSize | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | BarSeries | ||
fontStyle | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font. Recognized values are "normal" and "italic" .
The default value is "normal" . | BarSeries | ||
fontThickness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded FlashType font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is 0 .Related API Elements | BarSeries | ||
fontWeight | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface. Recognized values are "normal" and "bold" .
For LegendItem, the default is "bold" .
The default value is "normal" . | BarSeries | ||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | |||
itemRenderer | Type: mx.core.IFactory CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A factory that represents the class the series will use to represent individual items on the chart. This class is instantiated once for each element in the chart. Classes used as an itemRenderer should implement the IFlexDisplayObject, ISimpleStyleClient, and IDataRenderer interfaces. The data property is assigned the
chartItem that the skin instance renders.
| BarSeries | ||
kerning | Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled ( true ) or disabled (false ).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded FlashType fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false . | BarSeries | ||
labelAlign | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines the alignment of the label. Considered only if labelPostion
is inside . Possible values are center , left ,
and right .
The default value is "center" . | BarSeries | ||
labelClass | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10.2, AIR 2.0 The class that is used by this component to render labels. It can be set to either the mx.controls.Label class or the spark.components.Label class. The default value is spark.components.Label . | BarSeries | ||
labelPosition | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines the position of labels Possible values are "none" , "outside"
and "inside" .
The default value is "none" . | BarSeries | ||
labelSizeLimit | Type: Number CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the font size threshold, in points, below which labels are considered illegible. Below this threshold, Flex truncates the label. | BarSeries | ||
Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | |||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | |||
legendMarkerRenderer | Type: mx.core.IFactory CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The class that the series uses to render the series's marker in any associated legends. If this style is null , most series default to
using their itemRenderer as a legend marker skin instead. Classes used as legend markers should implement the IFlexDisplayObject interface, and optionally the ISimpleStyleClient and IDataRenderer interfaces.
If the class used as a legend marker implements the IDataRenderer interface, the data property is assigned a LegendData instance.
| BarSeries | ||
letterSpacing | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0 . | BarSeries | ||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | |||
Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | |||
Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | |||
stroke | Type: mx.graphics.IStroke CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the stroke style for this data series. You must specify a Stroke object to define the stroke. | BarSeries | ||
textAlign | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container. Possible values are "left" , "right" ,
or "center" .
The default value for most controls is | BarSeries | ||
textDecoration | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined. Possible values are "none" and "underline" .
The default value is "none" . | BarSeries | ||
textIndent | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. The default value is 0 . | BarSeries | ||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | |||
Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
barWidthRatio | property |
barWidthRatio:Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies how wide to render the bars relative to the category width.
A value of 1 uses the entire space, while a value of .6
uses 60% of the bar's available space.
You typically do not set this property directly.
The actual bar width used is the smaller of barWidthRatio
and the maxbarWidth
property
The default value is .65.
Implementation
public function get barWidthRatio():Number
public function set barWidthRatio(value:Number):void
fillFunction | property |
fillFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a method that returns the fill for the current chart item in the series.
If this property is set, the return value of the custom fill function takes precedence over the
fill
and fills
style properties.
But if it returns null, then fills
and fill
will be
prefered in that order.
The custom fillFunction
has the following signature:
function_name (item:ChartItem, index:Number):IFill { ... }
item
is a reference to the chart item that is being rendered.
index
is the index of the chart item in the renderData's cache. This is different
from the chart's data provider because it is sorted based on the x, y, and z values.
This function returns an object that implements the IFill
interface.
An example usage of a customized fillFunction
is to return a fill
based on some threshold.
Implementation
public function get fillFunction():Function
public function set fillFunction(value:Function):void
Example
How to use this example
public function myFillFunction(item:ChartItem, index:Number):IFill { var curItem:BarSeriesItem = BarSeriesItem(item); if (curItem.xNumber > 10) return(new SolidColor(0x123456, .75)); else return(new SolidColor(0x563412, .75)); }
If you specify a custom fill function for your chart series and you want to have a Legend control, you must manually create a Legend control and add LegendItems to it.
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 horizontalAxis 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
items | property |
items:Array
[read-only] [override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets all the items that are there in the series after filtering.
Individual series determine the list of items that are to be returned.
Implementation
override public function get items():Array
itemType | property |
itemType:Class
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The subtype of ChartItem used by this series to represent individual items. Subclasses can override and return a more specialized class if they need to store additional information in the items.
Implementation
protected function get itemType():Class
labelField | property |
labelField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Name of a field in the data provider whose value appears as the label.
This property is ignored if the labelFunction
property is specified.
Implementation
public function get labelField():String
public function set labelField(value:String):void
labelFunction | property |
labelFunction:Function
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a callback function used to render each label of the Series. A labelFunction must have the following signature:
function function_name(element:ChartItem, series:Series):String { ... }
element
is the chart item that is being rendered.
series
is the series to which the chart item belongs.
The returned String is the label of the current item.
An example usage of a customized labelFunction is as follows:
private function myLabelFunction(element:ChartItem, series:Series):String { var item:BarSeriesItem = BarSeriesItem(element); var ser:BarSeries = BarSeries(series); return(item.item.Country + ":" +"" + ser.xField.toString() +":"+ item.xNumber); }
Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
maxBarWidth | property |
maxBarWidth:Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the width of the bars, in pixels.
The actual bar width used is the smaller of this style and the barWidthRatio
property.
Clustered bars divide this space proportionally among the bars in each cluster.
Implementation
public function get maxBarWidth():Number
public function set maxBarWidth(value:Number):void
minField | property |
minField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the field of the data provider that determines the bottom of each bar.
If null
, the columns are based at
the range minimum (or maximum, if the field value is negative).
The default value is null.
Implementation
public function get minField():String
public function set minField(value:String):void
moduleFactory | property |
moduleFactory:IFlexModuleFactory
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
Implementation
override public function get moduleFactory():IFlexModuleFactory
override public function set moduleFactory(value:IFlexModuleFactory):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 bars from the center of the available space, relative the category width.
The range of values is a percentage in the range -100
to 100
.
Set to 0
to center the bars in 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 default value is 0.
Implementation
public function get offset():Number
public function set offset(value:Number):void
renderDataType | property |
renderDataType:Class
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The subtype of ChartRenderData used by this series to store all data necessary to render. Subclasses can override and return a more specialized class if they need to store additional information for rendering.
Implementation
protected function get renderDataType():Class
stacker | property |
stacker:StackedSeries
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The StackedSeries associated with this BarSeries. The stacker manages the series's stacking behavior.
Implementation
public function get stacker():StackedSeries
public function set stacker(value:StackedSeries):void
stackTotals | property |
stackTotals:Dictionary
[write-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The stack totals for the series.
Implementation
public function set stackTotals(value:Dictionary):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 verticalAxis 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
xField | property |
xField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the field of the data provider that determines the x-axis location of the top of each bar. If null
,
the BarSeries assumes that the data provider is an Array of numbers, and uses the numbers as values.
The default value is null.
Implementation
public function get xField():String
public function set xField(value:String):void
yField | property |
yField:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the field of the data provider that determines the y-axis location of the bottom of each bar in the chart.
If null
, Flex arranges the bars in the order of the data in the data provider.
The default value is null.
Implementation
public function get yField():String
public function set yField(value:String):void
BarSeries | () | Constructor |
public function BarSeries()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
applyItemRendererProperties | () | method |
protected function applyItemRendererProperties(instance:DisplayObject, cache:InstanceCache):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Customizes the item renderer instances that are used to represent the chart. This method is called automatically whenever a new item renderer is needed while the chart is being rendered. You can override this method to add your own customization as necessary.
Parameters
instance:DisplayObject — The new item renderer instance that is being created.
| |
cache:InstanceCache — The InstanceCache that is being used to manage the item renderer instances.
|
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.
createChildren | () | method |
override protected function createChildren():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Create child objects of the component. This is an advanced method that you might override when creating a subclass of UIComponent.
A component that creates other components or objects within it is called a composite component.
For example, the Flex ComboBox control is actually made up of a TextInput control
to define the text area of the ComboBox, and a Button control to define the ComboBox arrow.
Components implement the createChildren()
method to create child
objects (such as other components) within the component.
From within an override of the createChildren()
method,
you call the addChild()
method to add each child object.
You do not call this method directly. Flex calls the
createChildren()
method in response to the call to
the addChild()
method to add the component to its parent.
invalidateData | () | method |
override protected function invalidateData(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the underlying data
in the data provider has changed.
This function triggers calls to the updateData()
,
updateMapping()
, updateFilter()
,
and updateTransform()
methods on the next call
to the commitProperties()
method.
If any data effects are assigned to any elements of the chart,
this method also triggers the show and hide effects.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
invalidateMapping | () | method |
override protected function invalidateMapping(invalid:Boolean = true):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Informs the series that the mapping of the data into numeric values
has changed and must be recalculated.
Calling this function triggers calls to the updateMapping()
,
updateFilter()
, and updateTransform()
methods
on the next call to the commitProperties()
method.
If any data effects are assigned to any elements of the chart,
this method also triggers the show and hide effects.
Parameters
invalid:Boolean (default = true ) — If true , this method triggers calls
to the update methods.
|
stack | () | method |
public function stack(stackedYValueDictionary:Dictionary, previousElement:IStackable):Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Stacks the series. Normally, a series implements the updateData()
method
to load its data out of the data provider. But a stacking series performs special
operations because its values are not necessarily stored in its data provider.
Its values are whatever is stored in its data provider, summed with the values
that are loaded by the object it stacks on top of.
A custom stacking series should implement the stack()
method by loading its
data out of its data provider, adding it to the base values stored in the dictionary
to get the real values it should render with, and replacing the values in the dictionary
with its new, summed values.
Parameters
stackedYValueDictionary:Dictionary — Contains the base values that the series should stack
on top of. The keys in the dictionary are the x values, and the values are the y values.
| |
previousElement:IStackable — The previous element in the stack. If, for example, the element
is of the same type, you can use access to this property to avoid duplicate effort when
rendering.
|
Number — The maximum value in the newly stacked series.
|
stackAll | () | method |
public function stackAll(stackedPosYValueDictionary:Dictionary, stackedNegYValueDictionary:Dictionary, previousElement:IStackable2):Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Stacks the series. Normally, a series implements the updateData()
method
to load its data out of the data provider. But a stacking series performs special
operations because its values are not necessarily stored in its data provider.
Its values are whatever is stored in its data provider, summed with the values
that are loaded by the object it stacks on top of.
A custom stacking series should implement the stackAll()
method by loading its
data out of its data provider, adding it to the base values stored in the dictionary
to get the real values it should render with, and replacing the values in the dictionary
with its new, summed values.
Parameters
stackedPosYValueDictionary:Dictionary — Contains the base values that the series should stack
on top of. The keys in the dictionary are the y values, and the values are the positive
x values.
| |
stackedNegYValueDictionary:Dictionary — Contains the base values that the series should stack
on top of. The keys in the dictionary are the y values, and the values are the negative
x values.
| |
previousElement:IStackable2 — The previous element in the stack. If, for example, the element
is of the same type, you can use access to this property to avoid duplicate effort when
rendering.
|
Object — An object representing the maximum and minimum values in the newly stacked series.
|
<?xml version="1.0"?> <!-- Simple example to demonstrate the ColumnChart and BarChart controls. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <fx:Script> <![CDATA[ import mx.collections.ArrayCollection; [Bindable] private var medalsAC:ArrayCollection = new ArrayCollection( [ { Country: "USA", Gold: 35, Silver:39, Bronze: 29 }, { Country: "China", Gold: 32, Silver:17, Bronze: 14 }, { Country: "Russia", Gold: 27, Silver:27, Bronze: 38 } ]); ]]> </fx:Script> <fx:Declarations> <!-- Define custom colors for use as fills. --> <mx:SolidColor id="sc1" color="yellow" alpha=".8"/> <mx:SolidColor id="sc2" color="0xCCCCCC" alpha=".6"/> <mx:SolidColor id="sc3" color="0xFFCC66" alpha=".6"/> <!-- Define custom Strokes for the columns. --> <mx:SolidColorStroke id="s1" color="yellow" weight="2"/> <mx:SolidColorStroke id="s2" color="0xCCCCCC" weight="2"/> <mx:SolidColorStroke id="s3" color="0xFFCC66" weight="2"/> </fx:Declarations> <mx:Panel title="ColumnChart and BarChart Controls Example" height="100%" width="100%" layout="horizontal"> <mx:ColumnChart id="column" height="100%" width="45%" paddingLeft="5" paddingRight="5" showDataTips="true" dataProvider="{medalsAC}" > <mx:horizontalAxis> <mx:CategoryAxis categoryField="Country"/> </mx:horizontalAxis> <mx:series> <mx:ColumnSeries xField="Country" yField="Gold" displayName="Gold" fill="{sc1}" stroke="{s1}" /> <mx:ColumnSeries xField="Country" yField="Silver" displayName="Silver" fill="{sc2}" stroke="{s2}" /> <mx:ColumnSeries xField="Country" yField="Bronze" displayName="Bronze" fill="{sc3}" stroke="{s3}" /> </mx:series> </mx:ColumnChart> <mx:Legend dataProvider="{column}"/> <mx:BarChart id="bar" height="100%" width="45%" paddingLeft="5" paddingRight="5" showDataTips="true" dataProvider="{medalsAC}"> <mx:verticalAxis> <mx:CategoryAxis categoryField="Country"/> </mx:verticalAxis> <mx:series> <mx:BarSeries yField="Country" xField="Gold" displayName="Gold" fill="{sc1}" stroke="{s1}" /> <mx:BarSeries yField="Country" xField="Silver" displayName="Silver" fill="{sc2}" stroke="{s2}" /> <mx:BarSeries yField="Country" xField="Bronze" displayName="Bronze" fill="{sc3}" stroke="{s3}" /> </mx:series> </mx:BarChart> <mx:Legend dataProvider="{bar}"/> </mx:Panel> </s:Application>
Thu Dec 6 2018, 01:12 PM -08:00