| Adobe® Flex® 4 Beta Language Reference | All Packages | All Classes | Language Elements | Index | Appendixes | Conventions | Show Frames Hide Frames |  | |
| CandlestickChart | Properties | Methods | Events | Styles | Effects | Constants | Examples | ||
| Package | mx.charts |
| Class | public class CandlestickChart |
| Inheritance | CandlestickChart  CartesianChart ChartBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A CandlestickChart control expects its series property
to contain an array of CandlestickSeries objects.
Hide MXML Syntax
Show MXML Syntax<mx:CandlestickChart> tag inherits all the properties
of its parent classes and adds the following properties:
<mx:CandlestickChart
Styles
columnWidthRatio=".65"
maxColumnWidth="No default"
/>
Default MXML PropertydataProvider
See also
| Method | Defined By | ||
|---|---|---|---|
Constructor. | CandlestickChart | ||
 |
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| 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 | |
|
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 | |
|
Queues a function to be called later. | UIComponent | |
|
Deselects all selected chart items in the chart control. | ChartBase | |
|
Deletes a style property from this component instance. | UIComponent | |
|
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 as automation ID that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| Deprecated: Please Use IChartElement2.dataToLocal() [override]
Converts a tuple of data values to an x-y coordinate on screen. | CartesianChart | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
The default handler for the dragStart event. | ChartBase | |
|
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
Programatically 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 | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Returns an array of HitData objects that describe
the nearest data point to the coordinates passed to the method. | ChartBase | |
|
Called after printing is complete. | UIComponent | |
|
Returns an array of HitData objects representing the chart items
in the underlying objects that implement the IChartElement2 interface. | ChartBase | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
| Deprecated: Please Use Series.getAxis()
Retrieves the Axis instance for a particular dimension of the chart. | ChartBase | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| [override]
Gets the first item in the chart, with respect to the axes. | CartesianChart | |
|
Gets the object that currently has focus. | UIComponent | |
|
Gets all the chart items that are within the defined rectangular region. | ChartBase | |
| [override]
Gets the last chart item in the chart, with respect to the axes. | CartesianChart | |
|
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 | |
| [override]
Gets the chart item next to the currently focused item in the chart,
with respect to the axes. | CartesianChart | |
|
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 | |
| [override]
Gets the chart item that is before the currently focused item in the chart,
with respect to the axes. | CartesianChart | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
| Deprecated: Please Use Series.getAxis()
Retrieves the axis instance for a particular secondary dimension
of the chart. | CartesianChart | |
|
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 | |
|
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 | |
|
Informs the chart that the underlying data displayed in the chart
has been changed. | ChartBase | |
|
Hides the drop indicator that indicates that a
drag-and-drop operation is allowed. | ChartBase | |
|
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 | |
|
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 | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Triggers a redraw of the chart. | ChartBase | |
|
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 | |
|
Dispatches a new LegendDataChanged event. | ChartBase | |
|
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 | |
| Deprecated: Please Use IChartElement2.localToData() [override]
Converts a coordinate on screen to a tuple of data values. | CartesianChart | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Determins whether the current state of this component matches a
CSS pseudo-selector. | UIComponent | |
|
Determines whether this component is assignable to the given CSS type. | UIComponent | |
|
Measures the specified HTML text, which may 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 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 a listener from the EventDispatcher object. | EventDispatcher | |
|
Replays the specified event. | UIComponent | |
|
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 height and width of this object. | ChartBase | |
| Deprecated: Please Use Series.setAxis()
Assigns an Axis instance to a particular dimension of the chart. | ChartBase | |
|
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 to the specified dimensions. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but
doesn't trigger a layout pass. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
| Deprecated: Please Use Series.getAxis()
Assigns an axis instance to a particular secondary dimension
of the chart. | CartesianChart | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag-and-drop operation is allowed. | ChartBase | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Ends the startDrag() method. | Sprite | |
| [override]
Whenever any style changes, redraw this skin. | CartesianChart | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| UIComponent | ||
| transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
| UIComponent | |
|
Displays all noninteractive data tips
if showAllDataTips is set. | ChartBase | |
|
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 | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: yes The name of the CSS class selector to use when formatting titles on the axes. | CartesianChart | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: Array CSS Inheritance: no Contains a list of Strings, each corresponding to a CSS type selector to be used as the default CSS style for a series. | ChartBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | CartesianChart | ||
columnWidthRatio | Type: Number CSS Inheritance: no Specifies a ratio of how wide to draw the candlesticks relative to the horizontal axis's category widths, as a percentage in the range of 0 to 1. A value of 1 uses the entire space, while a value of 0.6 uses 60% of the column's available space. The actual candlestick width used is the smaller of the columnWidthRatio property and the
maxColumnWidth property.
Multiple candlestick series divide this space proportionally.
The default value is 0.65.
| CandlestickChart | ||
| Type: mx.graphics.IStroke CSS Inheritance: no The Stroke to use to render the callout line from the data tip target to the tip. | ChartBase | ||
| Type: Class CSS Inheritance: no Specifies the class to use to render data tips. | ChartBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | CartesianChart | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: mx.graphics.IFill CSS Inheritance: no Specifies the fill style used for the chart background. | ChartBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | CartesianChart | ||
| Type: String CSS Inheritance: yes Name of the font to use. | CartesianChart | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | CartesianChart | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | CartesianChart | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | CartesianChart | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | CartesianChart | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | CartesianChart | ||
| Type: String CSS Inheritance: no The class selector that defines the style properties for the default grid lines. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: no The size of the region, in pixels, between the bottom of the chart data area and the bottom of the chart control. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: no The size of the region, in pixels, between the left of the chart data area and the left of the chart control. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: no The size of the region, in pixels, between the right side of the chart data area and the outside of the chart control. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: no The size of the region, in pixels, between the top of the chart data area and the top of the chart control. | CartesianChart | ||
| Type: String CSS Inheritance: no Deprecated: Please Use horizontalAxisStyleNames The class selector that defines the style properties for the horizontal axis. | CartesianChart | ||
| Type: Array CSS Inheritance: no An array of class selectors that define the style properties for horizontal axes. | CartesianChart | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Color of disabled chartitem in the chart. | ChartBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of rolledOver chartitem in the chart. | ChartBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of selected chartitem in the chart. | ChartBase | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | CartesianChart | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | CartesianChart | ||
maxColumnWidth | Type: Number Format: Length CSS Inheritance: no Specifies how wide to draw the candlesticks, in pixels. The actual column width used is the smaller of this property and the columnWidthRatio property.
Multiple candlestick series divide this space proportionally.
| CandlestickChart | ||
| Type: int CSS Inheritance: no Specifies the maximum number of datatips a chart will show. | ChartBase | ||
| Type: Number Format: Length CSS Inheritance: no Specifies the number of pixels between the chart's bottom border and its content area. | ChartBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | ChartBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | ChartBase | ||
| Type: Number Format: Length CSS Inheritance: no Specifies the number of pixels between the chart's top border and its content area. | ChartBase | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: String CSS Inheritance: no Deprecated: Please Use horizontalAxisStyleNames The class selector that defines the style properties for the second horizontal axis. | CartesianChart | ||
| Type: String CSS Inheritance: no Deprecated: Please Use verticalAxisStyleNames The class selector that defines the style properties for the second vertical axis. | CartesianChart | ||
| Type: Boolean CSS Inheritance: no Specifies whether to show targets over the datapoints when showDataTips is set to true. | ChartBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | CartesianChart | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | CartesianChart | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | CartesianChart | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
| Type: String CSS Inheritance: no Deprecated: Please Use verticalAxisStyleNames The class selector that defines the style properties for the vertical axis. | CartesianChart | ||
| Type: Array CSS Inheritance: no An array of class selectors that define the style properties for vertical axes. | CartesianChart | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| CandlestickChart | () | Constructor |
public function CandlestickChart()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
<?xml version="1.0"?>
<!-- Simple example to demonstrate the CandlestickChart control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
import mx.collections.ArrayCollection;
[Bindable]
private var expensesAC:ArrayCollection = new ArrayCollection( [
{ Date: "25-Jul", Open: 40.75, High: 40.75, Low: 40.24, Close:40.31},
{ Date: "26-Jul", Open: 39.98, High: 40.78, Low: 39.97, Close:40.34},
{ Date: "27-Jul", Open: 40.38, High: 40.66, Low: 40, Close:40.63},
{ Date: "28-Jul", Open: 40.49, High: 40.99, Low: 40.3, Close:40.98},
{ Date: "29-Jul", Open: 40.13, High: 40.4, Low: 39.65, Close:39.95},
{ Date: "1-Aug", Open: 39.00, High: 39.50, Low: 38.7, Close:38.6},
{ Date: "2-Aug", Open: 38.68, High: 39.34, Low: 37.75, Close:38.84},
{ Date: "3-Aug", Open: 38.76, High: 38.76, Low: 38.03, Close:38.12},
{ Date: "4-Aug", Open: 37.98, High: 37.98, Low: 36.56, Close:36.69},
{ Date: "5-Aug", Open: 36.61, High: 37, Low: 36.48, Close:36.86} ]);
]]>
</mx:Script>
<!-- Define custom colors for the candles. -->
<mx:SolidColor id="up" color="green" alpha=".8"/>
<mx:SolidColor id="down" color="red" alpha=".8"/>
<!-- Define custom Stroke for the candle wick. -->
<mx:Stroke id="wick" color="black" weight="2"/>
<!-- Define custom Stroke for the candle box. -->
<mx:Stroke id="box" color="black" weight="1"/>
<mx:Panel title="CandlestickChart Control Example" height="100%" width="100%">
<mx:CandlestickChart id="candlestickchart"
height="100%"
width="100%"
paddingRight="5"
paddingLeft="5"
showDataTips="true"
dataProvider="{expensesAC}"
>
<mx:verticalAxis>
<mx:LinearAxis id="vaxis" baseAtZero="false" title="Price"/>
</mx:verticalAxis>
<mx:horizontalAxis>
<mx:CategoryAxis id="haxis" categoryField="Date" title="Date"/>
</mx:horizontalAxis>
<mx:horizontalAxisRenderers>
<mx:AxisRenderer axis="{haxis}" canDropLabels="true"/>
</mx:horizontalAxisRenderers>
<mx:series>
<mx:CandlestickSeries
openField="Open"
highField="High"
lowField="Low"
closeField="Close"
fill="{up}"
declineFill="{down}"
stroke="{wick}"
boxStroke="{box}"
/>
</mx:series>
</mx:CandlestickChart>
</mx:Panel>
</mx:Application>