org.axiis.charts.groupings.LineSeriesGroup

Public Properties

	Property		Defined By
		autoAdjustScale : Boolean Adjust min/max of vertical scale to fit data (does this destructively to the scale)	LineSeriesGroup
		bounds : Rectangle A rectangle that acts as the bounding area for this layout	AbstractLayout
		buttonMode : Boolean = false The value of the buttonMode flag to set for each child Sprite	BaseLayout
		childSprites : Array [read-only] The AxiisSprites this layout has created to render each item in its dataProvider.	AbstractLayout
		currentAxiisSprite : AxiisSprite The axiisSprite that the mouse is currently over within the layout this is helpful when keying mouseOver events to external components	LineSeriesGroup
		currentDatum : * [read-only] The item in the dataProvider that the layout is currently rendering.	AbstractLayout
		currentIndex : int [read-only] The index of the item in the dataProvider that the layout is currently rendering.	AbstractLayout
		currentLabel : String [read-only] The label of the item in the dataProvider that the layout is currently rendering, as determine by taking currentDatum[labelField], if a labelField is defined.	AbstractLayout
		currentReference : Geometry [read-only] The geometry that is being used to render the current data item as it appears after the necessary iterations of the referenceRepeater have been executed.	AbstractLayout
		currentValue : * [read-only] The value of the item in the dataProvider that the layout is currently rendering, as determined by taking currentDatum[dataField], if a dataField is defined.	AbstractLayout
		dataField : Object The property within each item in the dataProvider that contains the field used to determine the value of the item.	AbstractLayout
		dataFilterFunction : Function This provides a way to further refine a layouts dataProvider by providing access to a custom filter data filter function.	AbstractLayout
		dataFilterIndex : Number [read-only]	AbstractLayout
		dataItems : Array [read-only] An array of objects extracted from the dataProvider.	AbstractLayout
		dataProvider : Object An Array, ArrayCollection, or Object containing the data this layout should render.	AbstractLayout
		dataTipAnchorPoint : Object An Object with x and y values used to determine the location of anchored data tips.	AbstractLayout
		dataTipContentClass : IFactory A ClassFactory that creates the UIComponent that should be used in the data tip for this AxiisSprite.	AbstractLayout
		dataTipContentComponent : UIComponent A component that gets passed to any data tip.	AbstractLayout
		dataTipLabelFunction : Function A method used to determine the text that appears in the data tip for an item rendered by this layout.	AbstractLayout
		dataTipManager : IDataTipManager The IDataTipManager responsible for laying out data tips for children of this layout.	AbstractLayout
		drawingGeometries : Array An array of geometries that should be drawn for each item in the data provider.	AbstractLayout
		enableRollOver : Boolean = false Turns on/off the default roll-over state	LineSeriesGroup
		fill : IGraphicsFill The fill used to render the area beneath the lines if area rendering is enabled.	LineSeriesGroup
		fills : Array A placeholder for fills used within this layout.	AbstractLayout
		height : Number The height of the layout.	AbstractLayout
		horizontalScale : IScale The scale used to map values onto the horizontal axis.	LineSeriesGroup
		inheritParentBounds : Boolean = true Whether or not the drawingGeometries should should have their initial bounds set to the currentReference of the parent layout.	BaseLayout
		itemCount : int [read-only] The number of items in the dataProvider.	AbstractLayout
		labelField : Object The property within each item in the dataProvider that contains the field used to determine the label for the item.	AbstractLayout
		layouts : Array The layouts that should be displayed within this layout.	AbstractLayout
		markerColor : Number The color at the center of the markers.	LineSeriesGroup
		markerSize : int The diameter in pixels of the markers shown at each data point.	LineSeriesGroup
		mode : int The layout mode used to render the lines.	LineSeriesGroup
		mouseOverFill : IGraphicsFill The default fill to use for mouse over state.	LineSeriesGroup
		mouseOverStroke : IGraphicsStroke The default stroke to use for mouse over state.	LineSeriesGroup
		msPerRenderFrame : Number = 50 Determines how long (milliseconds) a layout will spend on a given frame to render X number of datums	AbstractLayout
		name : String A string used to identify this layout.	AbstractLayout
		palettes : Array A placeholder for palettes used within this layout.	AbstractLayout
		parentLayout : AbstractLayout A reference to the layout that contains this layout.	AbstractLayout
		plotCollection : String The name of the property on the objects in the dataProvider that contains the data to plot It is expected that the plot collection is a collection of objects - like Array or ArrayCollection and contains the series of data to be plotted.	LineSeriesGroup
		plotCount : Number number of plots being mapped on x axis	LineSeriesGroup
		plotFilterFunction : Function A filter function that will be used to determine whether a given data point should be included in the rendering.	LineSeriesGroup
		plotLabelField : String The property on the items in the dataProvider that contains the label field for the entire plot.	LineSeriesGroup
		plotLabelFunction : Function Label function that can be used for the plot labels	LineSeriesGroup
		referenceRepeater : GeometryRepeater A GeometryRepeater that will be applied to the drawingGeometries once for each item in the dataProvider.	AbstractLayout
		rendering : Boolean [read-only] Whether or not this layout is currently in a render cycle.	AbstractLayout
		scaleFill : Boolean Whether or not the fills in this geometry should be scaled within the bounds rectangle.	BaseLayout
		seriesLabelField : String The property on the items in the dataProvider that contains the label field for each series.	LineSeriesGroup
		seriesPoints : Array [read-only]	LineSeriesGroup
		showArea : Boolean Whether the area beneath the lines should be filled.	LineSeriesGroup
		showDataTips : Boolean A flag that indicates to DataCanvas that it should listen for mouse events that signal the need to create a data tip.	AbstractLayout
		showMarker : Boolean Whether or not markers should be displayed at each data point	LineSeriesGroup
		states : Array An array of states that should be applied to this layout.	AbstractLayout
		stroke : IGraphicsStroke The stroke used to render the lines.	LineSeriesGroup
		strokes : Array A placeholder for strokes used within this layout.	AbstractLayout
		tension : Number The tension used to render the curves in this chart.	LineSeriesGroup
		useHandCursor : Boolean = false The value of the useHandCursor flag to set each child Sprite	BaseLayout
		verticalScale : IScale Vertical scale that is used by the LineSeriesGroup	LineSeriesGroup
		visible : Boolean Whether or not this layout is visible.	AbstractLayout
		width : Number The width of the layout.	AbstractLayout
		x : Number The horizontal position of the top left corner of this layout within its parent.	AbstractLayout
		xDataField : String The property within each item in the dataProvider that contains the field used to determine the value of the item on the horizontal axis.	LineSeriesGroup
		y : Number The vertical position of the top left corner of this layout within its parent.	AbstractLayout

	Property	Defined By
		sprite : AxiisSprite The sprite this layout is currently rendering to.	AbstractLayout

	Method	Defined By
		LineSeriesGroup()	LineSeriesGroup
		getProperty(obj:Object, propertyName:Object):* Uses ObjectUtils.getProperty(this,obj,propertyName) to get a property on an object.	AbstractLayout
		getSprite(owner:DataCanvas):Sprite Returns the Sprite associated with this layout if owner is in fact the owner of this layout.	AbstractLayout
		invalidate():void Notifies the DataCanvas that this layout needs to be rendered.	AbstractLayout
		invalidateDataProvider():void Iterates over the items in the dataProvider and stores them in dataItems.	AbstractLayout
		registerOwner(dataCanvas:DataCanvas):void Registers a DisplayObject as the owner of this layout.	AbstractLayout
		render(newSprite:AxiisSprite = null):void Draws this layout to the specified AxiisSprite, tracking all changes made by data binding or the referenceRepeater.	BaseLayout

	Method	Defined By
		deselectChildren():void Marks all children as deselected.	AbstractLayout
		postIteration():void The callback method called by the referenceRepeater after it applies the PropertyModifiers on each iteration.	BaseLayout
		preIteration():void The callback method called by the referenceRepeater before it applies the PropertyModifiers on each iteration.	BaseLayout
		renderChildLayouts(child:AxiisSprite):void Calls the render method on all child layouts.	BaseLayout
		repeatComplete():void The callback method called by the referenceRepeater after it finishes its final iteration.	BaseLayout

Summary	Defined By
invalidateLayout	Dispatched when invalidate is called so the DataCanvas that owns this layout can being the process of redrawing the layout.	BaseLayout
itemClick	Dispatched when an AxiisSprite is clicked.	BaseLayout
itemDataTip	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemDoubleClick	Dispatched when an AxiisSprite is double clicked.	BaseLayout
itemMouseMove	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemMouseOut	Dispatched when an AxiisSprite is mousedOut.	BaseLayout
itemMouseOver	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemPreDraw	Dispatched before each individual child is rendered.	BaseLayout
itemSelected	Dispatched when an AxiisSprite is selected	BaseLayout
itemUnSelected	Dispatched when an AxiisSprite is unselected	BaseLayout
preRender	Dispatched at the beginning of the render method.	BaseLayout
renderComplete	Dispatched when layout has completed its render cycle	BaseLayout

	Constant	Defined By
		MODE_BASELINE : int = 0 [static] A flag indicating that lines should be rendered in the traditional line chart manner.	LineSeriesGroup
		MODE_STACK_FLOW : int = 2 [static] A flag indicating that lines should be rendered using a flow layout.	LineSeriesGroup
		MODE_STACK_ZERO : int = 1 [static] A flag indicating that lines should be rendered stacked on top of one another.	LineSeriesGroup

Property Detail

autoAdjustScale

property

public var autoAdjustScale:Boolean

Adjust min/max of vertical scale to fit data (does this destructively to the scale)

This property can be used as the source for data binding.

currentAxiisSprite

property

public var currentAxiisSprite:AxiisSprite

The axiisSprite that the mouse is currently over within the layout this is helpful when keying mouseOver events to external components

This property can be used as the source for data binding.

enableRollOver

property

public var enableRollOver:Boolean = false

Turns on/off the default roll-over state

This property can be used as the source for data binding.

fill

property

public var fill:IGraphicsFill

The fill used to render the area beneath the lines if area rendering is enabled.

This property can be used as the source for data binding.

horizontalScale

property

horizontalScale:IScale [read-write]

The scale used to map values onto the horizontal axis.

Implementation
public function get horizontalScale():IScale
public function set horizontalScale(value:IScale):void

markerColor

property

public var markerColor:Number

The color at the center of the markers.

This property can be used as the source for data binding.

markerSize

property

public var markerSize:int

The diameter in pixels of the markers shown at each data point.

This property can be used as the source for data binding.

mode

property

public var mode:int

The layout mode used to render the lines. One of {MODE_BASELINE,MODE_STACK_ZERO,MODE_STACK_FLOW}.

This property can be used as the source for data binding.

mouseOverFill

property

public var mouseOverFill:IGraphicsFill

The default fill to use for mouse over state.

This property can be used as the source for data binding.

mouseOverStroke

property

public var mouseOverStroke:IGraphicsStroke

The default stroke to use for mouse over state.

This property can be used as the source for data binding.

plotCollection

property

public var plotCollection:String

The name of the property on the objects in the dataProvider that contains the data to plot It is expected that the plot collection is a collection of objects - like Array or ArrayCollection and contains the series of data to be plotted. i.e. dataProvider=myObjects is Array || ArrayCollection myObjects[0].myPlotCollection is Array || ArrayCollection

This property can be used as the source for data binding.

plotCount

property

public var plotCount:Number

number of plots being mapped on x axis

This property can be used as the source for data binding.

plotFilterFunction

property

public var plotFilterFunction:Function

A filter function that will be used to determine whether a given data point should be included in the rendering. This filter function applies to the HORIZONTAL plots that are associated with a datum. LineSeries Group expects that each datum in the collection has its own child collection of series plots - referred to as the "plotCollection"

plotLabelField

property

public var plotLabelField:String

The property on the items in the dataProvider that contains the label field for the entire plot.

This property can be used as the source for data binding.

plotLabelFunction

property

public var plotLabelFunction:Function

Label function that can be used for the plot labels

This property can be used as the source for data binding.

seriesLabelField

property

public var seriesLabelField:String

The property on the items in the dataProvider that contains the label field for each series.

This property can be used as the source for data binding.

seriesPoints

property

seriesPoints:Array [read-only]

Implementation
public function get seriesPoints():Array

showArea

property

public var showArea:Boolean

Whether the area beneath the lines should be filled.

This property can be used as the source for data binding.

showMarker

property

public var showMarker:Boolean

Whether or not markers should be displayed at each data point

This property can be used as the source for data binding.

stroke

property

public var stroke:IGraphicsStroke

The stroke used to render the lines.

This property can be used as the source for data binding.

tension

property

public var tension:Number

The tension used to render the curves in this chart. A value of 0 results in straight lines while a value of 1 results in exaggerated Bezier curves.

This property can be used as the source for data binding.

verticalScale

property

public var verticalScale:IScale

Vertical scale that is used by the LineSeriesGroup

This property can be used as the source for data binding.

xDataField

property

xDataField:String [read-write]

The property within each item in the dataProvider that contains the field used to determine the value of the item on the horizontal axis.

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

Constructor Detail

LineSeriesGroup

()

Constructor

public function LineSeriesGroup()

Constant Detail

MODE_BASELINE

Constant

public static const MODE_BASELINE:int = 0

A flag indicating that lines should be rendered in the traditional line chart manner.

MODE_STACK_FLOW

Constant

public static const MODE_STACK_FLOW:int = 2

A flag indicating that lines should be rendered using a flow layout.

MODE_STACK_ZERO

Constant

public static const MODE_STACK_ZERO:int = 1

A flag indicating that lines should be rendered stacked on top of one another.

Fri Oct 2 2009, 08:24 PM -04:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
LineSeriesGroup	Properties \| Methods \| Events \| Constants

Package	org.axiis.charts.groupings
Class	public class LineSeriesGroup
Inheritance	LineSeriesGroup RepeaterLayout BaseLayout AbstractLayout flash.events.EventDispatcher
Implements	mx.binding.IBindingClient