com.flexicious.components.tinycharts.valueobjects.HLOCSeries

Public Properties

	Property		Defined By
		baseAtZero : Boolean Specifies whether Flex tries to keep the minimum and maximum values rooted at zero.	Series
		calculatedMinMaxSum : Array Calculated result of the minmaxsum function.	Series
		chart : TinyChartBase	Series
		closeField : String Specifies the field of the data provider that determines the y-axis location of the closing value of the element.	HLOCSeries
		columnWidthRatio : Number Specifies the width of elements relative to the category width.	HLOCSeries
		dataFunction : Function Specifies a method that returns the value that should be used for positioning the current chart item in the series.	Series
		dataPropertyName : String [override] Returns the attribute on the series that returns the data field on the dataprovider.	HLOCSeries
		dataTipRenderer : IFactory Renderer for the data tip.	Series
		displayName : String The name of the series, for display to the user.	Series
		enabledFunction : Function Given an item, returns the color for its renderer (line, or column)	Series
		highField : String Specifies the field of the data provider that determines the y-axis location of the high value of the element.	HLOCSeries
		interactive : Boolean Determines whether data tips appear when users interact with chart data on the screen.	Series
		isSecondary : Boolean = false Is this a secondary series (not used to render the axes), used by Multi Series Charts.	Series
		itemFillFunction : Function = null Given an item, returns the color for its renderer (line, or column) .	Series
		itemLineColorFunction : Function = null Given an item, returns the color for its line (or border for its fill) .	Series
		labelFunction : Function Specifies a callback function used to render each label of the Series.	Series
		labelPropertyName : String [read-only] Returns the attribute on the series that returns the data field on the dataprovider.	Series
		labelStyleName : String This is the style name applied to labels that are drawn on top of individual datapoints For now this is supported for 3d Pie, Funnel and Pyramid Charts, since they are the only ones that draw a label on top of the individual data points.	Series
		lowField : String Specifies the field of the data provider that determines the y-axis location of the low value of the element.	HLOCSeries
		minMaxSumFunction : Function PLEASE NOTE: Starting 2.10 this function is deprecated.	Series
		minMaxSumIntervalFunction : Function Returns an array of 4 values.	Series
		openField : String Specifies the field of the data provider that determines the y-axis location of the opening value of the element.	HLOCSeries
		painter : TinyChartPainterBase The painter responsible for painting the series.	Series
		plotPoints : Array A list of plot points we calculated to render this series	Series
		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
		seriesIndex : int = 0 The index of this series within the charts series collection.	Series
		showDataTips : Boolean Whether or not to show data tips on mouse over	Series
		useRollover : Boolean Flag to show a different color for the bar/area that the user has rolled over.	Series
		xField : String Specifies the field of the data provider that determines the x-axis location of the column.	CartesianSeries
		yField : String Specifies the field of the data provider that determines the y-axis location of the top of a column.	CartesianSeries

	Method	Defined By
		HLOCSeries()	HLOCSeries
		calculateSteps(minValue:Number, maxValue:Number, sum:Number):Array	Series
		defaultDataFunction(series:Series, item:Object, fieldName:String):* [static]	Series
		getFillForLegend():IFill Gets the fill associated with this item for this series.	Series
		getItemFill(item:Object):IFill First, checks to see if item is disabled, then returns disabled color style value, if one defined for the series, other wise the one defined for the chart.	Series
		getItemLineColor(item:Object):IFill	Series
		getLabelForLegend():String Gets the label associated with this item for this series.	Series
		getLineThickness():uint	HLOCSeries
		getNegativeColor():uint	HLOCSeries
		getPlotPoint(item:Object):PlotPoint Gets the plot point for this item in this series before this one.	Series
		getPositiveColor():uint	HLOCSeries
		getPreviousSeries():Series Gets the series before this one.	Series
		getStyleValue(prop:String):Object If a style is defined on this series with a valid value, returns it from the series style declaration otherwise, returns it from the chart's style declaration.	Series
		handleMouseClick(event:MouseEvent, clickedItem:HitData):void Handles the click.	Series

	Method	Defined By
		defaultMinMaxSumFunction(series:Series):Array Returns the top and bottom for the chart scale.	Series
		getFillForItem(styleProp:String, item:Object):IFill Takes a style property, if it is an array, returns the item in the array according to the mod position of the item in the dataprovider	Series

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
backgroundFill	Type: mx.graphics.IFill CSS Inheritance: no	Series
closeTickLength	Type: Number Format: Length CSS Inheritance: no Specifies the length, in pixels, for the close tick mark. Regardless of this value, an HLOCSeries will not render the close tick mark outside of the area assigned to the individual element.	HLOCSeries
closeTickStroke	Type: mx.graphics.IStroke CSS Inheritance: no Specifies the stroke to use for the close tick mark if an opening value is specified.	HLOCSeries
itemDisabledFills	Type: Array	Series
itemDisabledLineColors	Type: Array	Series
itemFills	Type: Array	Series
itemLineColors	Type: Array	Series
itemRollOverFills	Type: Array	Series
itemRollOverLineColors	Type: Array	Series
itemSelectionFills	Type: Array	Series
itemSelectionLineColors	Type: Array	Series
openTickLength	Type: Number Format: Length CSS Inheritance: no Specifies the length, in pixels, for the open tick mark if an opening value is specified. Regardless of this value, an HLOCSeries will not render the open tick mark outside of the area assigned to the individual element.	HLOCSeries
openTickStroke	Type: mx.graphics.IStroke CSS Inheritance: no Specifies the stroke to use for the open tick mark if an opening value is specified.	HLOCSeries
stroke	Type: mx.graphics.IStroke CSS Inheritance: no Sets the stroke style for this data series. You must specify a Stroke object to define the stroke.	HLOCSeries

Property Detail

closeField

property

closeField:String

Specifies the field of the data provider that determines the y-axis location of the closing value of the element.

The default value is "".

Implementation
public function get closeField():String
public function set closeField(value:String):void

columnWidthRatio

property

columnWidthRatio:Number

Specifies the width of elements relative to the category width. A value of 1 uses the entire space, while a value of 0.6 uses 60% of the element's available space. You typically do not set this property directly. The actual element width used is the smaller of the columnWidthRatio and maxColumnWidth properties.

The default value is 0.65..

Implementation
public function get columnWidthRatio():Number
public function set columnWidthRatio(value:Number):void

dataPropertyName

property

dataPropertyName:String[override]

Returns the attribute on the series that returns the data field on the dataprovider. Defaults to "yField" for most series, and "field" for Pie Series.

Implementation
public function get dataPropertyName():String
public function set dataPropertyName(value:String):void

highField

property

highField:String

Specifies the field of the data provider that determines the y-axis location of the high value of the element.

The default value is "".

Implementation
public function get highField():String
public function set highField(value:String):void

lowField

property

lowField:String

Specifies the field of the data provider that determines the y-axis location of the low value of the element.

The default value is "".

Implementation
public function get lowField():String
public function set lowField(value:String):void

openField

property

openField:String

Specifies the field of the data provider that determines the y-axis location of the opening value of the element.

The default value is "".

Implementation
public function get openField():String
public function set openField(value:String):void

Constructor Detail

HLOCSeries

()

Constructor

public function HLOCSeries()

Method Detail

getLineThickness

()

method

public function getLineThickness():uint

Returns

uint

getNegativeColor

()

method

public function getNegativeColor():uint

Returns

uint

getPositiveColor

()

method

public function getPositiveColor():uint

Returns

uint

Mon Jun 24 2013, 11:00 PM -04:00

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
HLOCSeries	Properties \| Methods \| Styles

Package	com.flexicious.components.tinycharts.valueobjects
Class	public class HLOCSeries
Inheritance	HLOCSeries CartesianSeries Series mx.styles.CSSStyleDeclaration
Subclasses	CandleStickSeries