xp.charting.CandlestickSeries

Package	xp.charting
Class	public class CandlestickSeries
Inheritance	CandlestickSeries HLOCSeries AxisSeries Series ChartStyleClient ChartDisplayElement ProgrammaticSkin mx.core.FlexSprite

Represents financial data as a series of candlesticks representing the high, low, opening, and closing values of a data series. The top and bottom of the vertical line in each candlestick represent the high and low values for the datapoint, while the top and bottom of the filled box represent the opening and closing values. Each candlestick is filled differently depending on whether the closing value for the datapoint is higher or lower than the opening value.

MXML Syntax expanded

Hide MXML Syntax

The <mx:CandlestickSeries> tag inherits all the properties of its parent classes, and the following properties:

  <mx:CandlestickSeries
    Styles
    downFill="IFill; no default"
    upFill="IFill; no default"
  />

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		annotations : Array The annotations for this series	Series
		axisMode : Number The axis mode for this series	AxisSeries
		chart : IChartArea	ChartDisplayElement
		chartDesc : ChartDesc	ChartDisplayElement
		chartParent : IChart	ChartDisplayElement
		className : String	ChartStyleClient
		closeField : String = "close"	HLOCSeries
		dataEffectIn : ChartEffect	Series
		dataEffectOut : ChartEffect	Series
		dataProvider : Object The source of the chart items.	Series
		dataTipFormat : String The format for the data tip display For axis series the elements are {0} = series Name {1} = xAxis Name {2} = x value {3} = yAxis Name {4} = y value {5} = Annotation The default value is <b>{0}</b><br/>,<i>{1}:</i>,{2}\n,<i>{3}:</i>,{4},{5} For pie series the elements are {0} = label {1} = value {2} = percent The default value is {0}\r{2}	Series
		dataTipFunction : Function	Series
		displayName : String = "" name for this series	Series
		graphMode : String = "2D" The default chart type one of pie2D, pie25D, pie3D, doughnut	Series
		height : Number	ProgrammaticSkin
		highField : String = "hi"	HLOCSeries
		inheritingStyles : Object	ChartStyleClient
		initialized : Boolean	ProgrammaticSkin
		isFilledArea : Boolean = false is the area filled this series	Series
		isRotated : Boolean Indicates whether this series is rendered horizontally (rotated)	Series
		isSubChart : Boolean	ChartDisplayElement
		items : Array The array of DataItems represented by this series	Series
		labelFormat : String The format for the data label display For axis series the elements are {0} = series Name {1} = xAxis Name {2} = x value {3} = yAxis Name {4} = y value {5} = Annotation The default value is <b>{0}</b><br/>,<i>{1}:</i>,{2}\n,<i>{3}:</i>,{4},{5} For pie series the elements are {0} = label {1} = value {2} = percent The default value is {2}	Series
		labelFunction : Function	Series
		labelOffset : Number = 0 controls the distance between a label and the pie	Series
		labelPosition : String Specifies how to render value labels.	Series
		legendFormat : String The format for the legend display For axis series the elements are {0} = series Name {1} = xAxis Name {2} = x value {3} = yAxis Name {4} = y value {5} = Annotation The default value is <b>{0}</b><br/>,<i>{1}:</i>,{2}\n,<i>{3}:</i>,{4},{5} For pie series the elements are {0} = label {1} = value {2} = percent The default value is {0} [{2}]	Series
		legendFunction : Function	Series
		length : int The number of DataItems in this series	Series
		lowField : String = "lo"	HLOCSeries
		measuredHeight : Number The measured height of this object.	ChartDisplayElement
		measuredWidth : Number The measured width of this object.	ChartDisplayElement
		nestLevel : int	ProgrammaticSkin
		nonInheritingStyles : Object	ChartStyleClient
		openField : String = "open"	HLOCSeries
		parent : DisplayObjectContainer	ChartDisplayElement
		processedDescriptors : Boolean	ProgrammaticSkin
		selectedItem : DataPoint	Series
		selectedText : String	Series
		seriesSet : SeriesSet	AxisSeries
		styleDeclaration : CSSStyleDeclaration	ChartStyleClient
		styleName : Object	ChartStyleClient
		trackMouse : Boolean = false	Series
		updateCompletePendingFlag : Boolean	ProgrammaticSkin
		useGradient : Boolean = false use a gradient fill for series	Series
		volume : Number Allows you to specify a volume for data series markers By adjusting the volume, you can modify the amount of space between data points in the series.	Series
		width : Number	ProgrammaticSkin
		xAxis : Axis x axis that this series is assigned to	AxisSeries
		xField : String The name of the field in the data that will be used as the source for the x value of this series If the data is a simple array this property is ignored	AxisSeries
		yAxis : Axis y axis that this series is assigned to	AxisSeries
		yField : String The name of the field in the data that will be used as the source for the y value of this series If the data is a simple array this property is ignored	AxisSeries

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		_axisMode : Number = 1	AxisSeries
		_chartDataProvider : ICollectionView	Series
		_chartLabels : LabelCache	Series
		chartLabels : LabelCache	Series
		chartStyleChanged : Boolean = true	Series
		chartStyles : Object	Series
		childList : Array	ChartStyleClient
		_dataEffectIn : ChartEffect	Series
		_dataEffectOut : ChartEffect	Series
		dataItemClass : Class	Series
		_dataProvider : ICollectionView	Series
		dataProviderChanged : Boolean = false	Series
		_dataTipFormat : String	Series
		_deferLayout : Boolean = false	ProgrammaticSkin
		dropLines : Shape	AxisSeries
		_dropLineStroke : IStroke	AxisSeries
		dropShadowStyleChanged : Boolean = true	Series
		dropShadowTarget : DisplayObject	Series
		fieldMap : Object	Series
		fields : Array	Series
		graphicsLayer : Shape	AxisSeries
		invalidateDisplayListFlag : Boolean = false	ProgrammaticSkin
		invalidatePropertiesFlag : Boolean = false	ProgrammaticSkin
		invalidateSizeFlag : Boolean = false	ProgrammaticSkin
		invalidDataScale : Boolean = false	Series
		invalidFields : Boolean = true	Series
		invalidSeriesData : Boolean = false	Series
		_isRotated : Boolean = false	Series
		_items : Array	Series
		_labelFormat : String	Series
		_labelPosition : String = "none"	Series
		lastMouseX : int	Series
		lastMouseY : int	Series
		_legendData : Array	Series
		_legendFormat : String	Series
		_marker : Marker	Series
		_markerRenderer : IMarkerRenderer	Series
		markers : Shape	AxisSeries
		_markers : Array	Series
		_markerSize : int	Series
		_markerStroke : IStroke	Series
		_markerType : String	Series
		owner : Object	ChartStyleClient
		_palette : Palette	Series
		paletteBaseIndex : int = 0	Series
		paletteItemCount : int = 1	Series
		_parent : DisplayObjectContainer	ChartDisplayElement
		_selectedItem : DataPoint	Series
		_seriesDataProvider : ICollectionView	Series
		_showAnnotations : Boolean	Series
		_showCursor : Boolean	Series
		_showDataTips : Boolean	Series
		_showDropLines : Boolean = true controls whether drop lines are shown	AxisSeries
		_showLabels : Boolean	Series
		_showMarkers : Boolean	Series
		sizeChanged : Boolean = false	ProgrammaticSkin
		styleParent : IStyleClient	ChartStyleClient
		stylesInitialized : Boolean = false	ChartStyleClient
		textFieldList : Array	ChartStyleClient
		_trackMouse : Boolean = false	Series
		_volume : Number = .8	Series
		_xAxis : Axis	AxisSeries
		_xField : String	AxisSeries
		xOffset : int	Series
		_yAxis : Axis	AxisSeries
		_yField : String	AxisSeries

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		CandlestickSeries() Constructor	CandlestickSeries
		axesChanged():void Notifes the series that parent SeriesSet's assigned chartAxes may have been changed.	AxisSeries
		clearStyle(styleProp:String):void	ChartStyleClient
		determineTextFormatFromStyles():UITextFormat	ChartStyleClient
		getClassStyleDeclarations():Array	ChartStyleClient
		getDataPoint(x:int, y:int, sensitivity:int, checkXY:Boolean = true):DataPoint	Series
		getField(fieldName:String):DataFieldDesc	Series
		getMax(axisType:String):Number	AxisSeries
		getMin(axisType:String):Number	AxisSeries
		getMinInterval(axisType:String):Number	AxisSeries
		getStyle(styleProp:String):*	ChartStyleClient
		hasField(fieldName:String):Boolean	Series
		initElement(chart:IChartArea):void	ChartDisplayElement
		invalidateDisplayList():void	ProgrammaticSkin
		invalidateProperties():void	ProgrammaticSkin
		invalidateSize():void	ProgrammaticSkin
		move(x:Number, y:Number):void Moves this object to the specified x and y coordinates.	ProgrammaticSkin
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void	ChartStyleClient
		parentChanged(p:DisplayObjectContainer):void	ChartStyleClient
		regenerateStyleCache(recursive:Boolean):void	ChartStyleClient
		registerEffects(effects:Array):void	ChartStyleClient
		setActualSize(newWidth:Number, newHeight:Number):void Sets the height and width of this object.	ProgrammaticSkin
		setChartDimensions():void Set the physical pixel size of the chart	AxisSeries
		setStyle(styleProp:String, newValue:*):void	ChartStyleClient
		styleChanged(styleProp:String):void Whenever any style changes, redraw this skin.	Series
		validateDisplayList():void	ChartDisplayElement
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	ProgrammaticSkin
		validateProperties():void	ProgrammaticSkin
		validateSize(recursive:Boolean = false):void	ChartDisplayElement

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		activate():void	ChartDisplayElement
		addedHandler(e:Event):void	ChartDisplayElement
		axesChangedHandler(e:Event):void	AxisSeries
		axisModeChangeHandler(e:Event):void Called when the x axis mode changes	AxisSeries
		axisRangeChangedHandler(e:Event):void Called when the axis range changes	AxisSeries
		chartStateChangedHandler(e:StateChangeEvent):void	Series
		checkDataPoint(x:int, y:int, sensitivity:int, checkXY:Boolean = true):DataPoint	CandlestickSeries
		commitProperties():void	Series
		createChildren():void	ChartDisplayElement
		createLabelInstance():Object	AxisSeries
		deactivate():void	ChartDisplayElement
		deferLayout(state:Boolean):void	ProgrammaticSkin
		drawDropLines():void	AxisSeries
		drawLabel(item:*, i:int, x:int, y:int, position:String = null):void	AxisSeries
		drawLabels():void	AxisSeries
		drawMarkers():void	AxisSeries
		drawSeries():void draw this series	AxisSeries
		getFill(index:int = -1):IFill	Series
		getFormattedText(item:DataItem, type:String):String	AxisSeries
		getLegendData():Array	Series
		getMarker(index:int = -1):Marker	Series
		getPalette():Palette	Series
		getParent():DisplayObjectContainer	ChartDisplayElement
		getParsedDataTipFormat():Array	Series
		getParsedLabelFormat():Array	Series
		getParsedLegendFormat():Array	Series
		getSeriesDataFields():Array	HLOCSeries
		getStroke(index:int = -1):IStroke	Series
		initDataPoint(item:DataItem):DataPoint	Series
		initHierarchy():void	ChartDisplayElement
		initialize():void	AxisSeries
		initializeStyles():void	ChartStyleClient
		initProperties():void	Series
		initTextFields():void	ChartStyleClient
		invalidateDataScale():void	Series
		invalidateFields():void	Series
		invalidateLegendData():void	Series
		invalidateSeriesData():void	Series
		measure():void	ProgrammaticSkin
		nestLevelChanged():void	ProgrammaticSkin
		notifyTextFieldStyleChange(styleProp:String):void	ChartStyleClient
		plotSizeChangedHandler(e:Event):void	ChartDisplayElement
		removedHandler(e:Event):void	ChartDisplayElement
		renderItems():void	CandlestickSeries
		resetForRenderSeries():void Clear all the draw surfaces	AxisSeries
		setChartDataProvider(value:Object):void	Series
		setData(cursor:IViewCursor):void	Series
		setDataPoint(item:DataItem):void	Series
		setDataProvider(value:ICollectionView):void	Series
		setOrientation(isHorizontal:Boolean = true):void Sets the orientation of the series	AxisSeries
		setSelectedItem(item:DataPoint):void	Series
		setShowCursor(value:Boolean):void	Series
		setShowDataTips(value:Boolean):void	Series
		setShowLabels(value:Boolean):void	Series
		setTrackMouse(value:Boolean):void	Series
		updateChartStyles():void	AxisSeries
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draw the series	AxisSeries
		updateFields():void	Series
		updateRenderConfig():void	HLOCSeries
		updateSeriesData():void Initializes the SeriesData object for the new dataProvider	Series
		validateData():void	Series

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined by
downFill	Type: mx.graphics.IFill CSS Inheritance: no Sets the declining fill for this data series, used when the closing value of an element is less than the opening value. 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.	CandlestickSeries
dropShadowEnabled	Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow.	Series
fill	Type: mx.graphics.IFill CSS Inheritance: no Sets the fill for this data series.	Series
hiloStroke	Type: mx.graphics.IStroke CSS Inheritance: no Specifies the stroke to use for hilo line if an opening value is specified.	HLOCSeries
legendMarkerRenderer	Type: xp.charting.IMarkerRenderer CSS Inheritance: yes	Series
legendMarkerSize	Type: int CSS Inheritance: yes	Series
legendMarkerStroke	Type: mx.graphics.IStroke CSS Inheritance: yes	Series
legendMarkerType	Type: String CSS Inheritance: yes	Series
markerRenderer	Type: xp.charting.IMarkerRenderer CSS Inheritance: yes	Series
markerSize	Type: int CSS Inheritance: yes	Series
markerStroke	Type: mx.graphics.IStroke CSS Inheritance: yes	Series
markerType	Type: String CSS Inheritance: yes	Series
paletteStrokeWidth	Type: Number CSS Inheritance: no Sets the stroke width for this data series.	Series
shadowAlpha	Type: Number CSS Inheritance: no The drop shadow alpha	Series
shadowColor	Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow.	Series
shadowDirection	Type: String CSS Inheritance: no Direction of the drop shadow.	Series
shadowDistance	Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow.	Series
showCursor	Type: Boolean CSS Inheritance: no Controls whether a cursor is attached to this series Only one series per chart (or subchart) can have a cursor attached	Series
showDataTips	Type: Boolean CSS Inheritance: yes	Series
showMarkers	Type: Boolean CSS Inheritance: yes controls whether marker are always shown(if false they are only shown with tooltip)	Series
stroke	Type: mx.graphics.IStroke CSS Inheritance: no Sets the stroke style for this data series.	Series
tickLength	Type: Number Format: Length CSS Inheritance: no Specifies the length, in pixels, for the open and close tick mark.	HLOCSeries
tickStroke	Type: mx.graphics.IStroke CSS Inheritance: no Specifies the stroke to use for the open/close tick mark if an opening value is specified.	HLOCSeries
upFill	Type: mx.graphics.IFill CSS Inheritance: no Sets the advancing fill for this data series, used when the closing value of an element is greater than the opening value. 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.	CandlestickSeries

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined by
		NESTLEVEL_AXIS : int = 10000 [static]	ChartDisplayElement
		NESTLEVEL_AXISSET : int = 10001 [static]	ChartDisplayElement
		NESTLEVEL_LABELS : int = 10002 [static]	ChartDisplayElement
		NESTLEVEL_SERIES : int = 1000 [static]	ChartDisplayElement
		NESTLEVEL_SERIESSET : int = 1001 [static]	ChartDisplayElement
		nullStroke : IStroke [static]	Series
		rc : Rectangle [static]	Series

Constructor detail

CandlestickSeries

()

constructor

public function CandlestickSeries()

Constructor

Method detail

checkDataPoint

()

method

protected override function checkDataPoint(x:int, y:int, sensitivity:int, checkXY:Boolean = true):DataPointParameters

	`x:int`

	`y:int`

	`sensitivity:int`

	`checkXY:Boolean` (default = `true`)

Returns

DataPoint

renderItems

()

method

protected override function renderItems():void

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class CandlestickSeries	Properties \| Methods \| Styles \| Constants