Packageorg.axiis.charts.groupings
Classpublic class LineSeriesGroup
InheritanceLineSeriesGroup Inheritance RepeaterLayout Inheritance BaseLayout Inheritance AbstractLayout Inheritance flash.events.EventDispatcher
Implements mx.binding.IBindingClient

Line series group renders multiple lines for a series of data points. This can be used to create visualizations that use curved surfaces such as stream graphs and line charts.



Public Properties
 PropertyDefined By
  autoAdjustScale : Boolean
Adjust min/max of vertical scale to fit data (does this destructively to the scale)
LineSeriesGroup
 Inheritedbounds : Rectangle
A rectangle that acts as the bounding area for this layout
AbstractLayout
 InheritedbuttonMode : Boolean = false
The value of the buttonMode flag to set for each child Sprite
BaseLayout
 InheritedchildSprites : 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
 InheritedcurrentDatum : *
[read-only] The item in the dataProvider that the layout is currently rendering.
AbstractLayout
 InheritedcurrentIndex : int
[read-only] The index of the item in the dataProvider that the layout is currently rendering.
AbstractLayout
 InheritedcurrentLabel : 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
 InheritedcurrentReference : 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
 InheritedcurrentValue : *
[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
 InheriteddataField : Object
The property within each item in the dataProvider that contains the field used to determine the value of the item.
AbstractLayout
 InheriteddataFilterFunction : Function
This provides a way to further refine a layouts dataProvider by providing access to a custom filter data filter function.
AbstractLayout
 InheriteddataFilterIndex : Number
[read-only]
AbstractLayout
 InheriteddataItems : Array
[read-only] An array of objects extracted from the dataProvider.
AbstractLayout
 InheriteddataProvider : Object
An Array, ArrayCollection, or Object containing the data this layout should render.
AbstractLayout
 InheriteddataTipAnchorPoint : Object
An Object with x and y values used to determine the location of anchored data tips.
AbstractLayout
 InheriteddataTipContentClass : IFactory
A ClassFactory that creates the UIComponent that should be used in the data tip for this AxiisSprite.
AbstractLayout
 InheriteddataTipContentComponent : UIComponent
A component that gets passed to any data tip.
AbstractLayout
 InheriteddataTipLabelFunction : Function
A method used to determine the text that appears in the data tip for an item rendered by this layout.
AbstractLayout
 InheriteddataTipManager : IDataTipManager
The IDataTipManager responsible for laying out data tips for children of this layout.
AbstractLayout
 InheriteddrawingGeometries : 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
 Inheritedfills : Array
A placeholder for fills used within this layout.
AbstractLayout
 Inheritedheight : Number
The height of the layout.
AbstractLayout
  horizontalScale : IScale
The scale used to map values onto the horizontal axis.
LineSeriesGroup
 InheritedinheritParentBounds : Boolean = true
Whether or not the drawingGeometries should should have their initial bounds set to the currentReference of the parent layout.
BaseLayout
 InheriteditemCount : int
[read-only] The number of items in the dataProvider.
AbstractLayout
 InheritedlabelField : Object
The property within each item in the dataProvider that contains the field used to determine the label for the item.
AbstractLayout
 Inheritedlayouts : 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
 InheritedmsPerRenderFrame : Number = 50
Determines how long (milliseconds) a layout will spend on a given frame to render X number of datums
AbstractLayout
 Inheritedname : String
A string used to identify this layout.
AbstractLayout
 Inheritedpalettes : Array
A placeholder for palettes used within this layout.
AbstractLayout
 InheritedparentLayout : 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
 InheritedreferenceRepeater : GeometryRepeater
A GeometryRepeater that will be applied to the drawingGeometries once for each item in the dataProvider.
AbstractLayout
 Inheritedrendering : Boolean
[read-only] Whether or not this layout is currently in a render cycle.
AbstractLayout
 InheritedscaleFill : 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
 InheritedshowDataTips : 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
 Inheritedstates : Array
An array of states that should be applied to this layout.
AbstractLayout
  stroke : IGraphicsStroke
The stroke used to render the lines.
LineSeriesGroup
 Inheritedstrokes : Array
A placeholder for strokes used within this layout.
AbstractLayout
  tension : Number
The tension used to render the curves in this chart.
LineSeriesGroup
 InheriteduseHandCursor : 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
 Inheritedvisible : Boolean
Whether or not this layout is visible.
AbstractLayout
 Inheritedwidth : Number
The width of the layout.
AbstractLayout
 Inheritedx : 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
 Inheritedy : Number
The vertical position of the top left corner of this layout within its parent.
AbstractLayout
Protected Properties
 PropertyDefined By
 Inheritedsprite : AxiisSprite
The sprite this layout is currently rendering to.
AbstractLayout
Public Methods
 MethodDefined By
  
LineSeriesGroup
 Inherited
getProperty(obj:Object, propertyName:Object):*
Uses ObjectUtils.getProperty(this,obj,propertyName) to get a property on an object.
AbstractLayout
 Inherited
getSprite(owner:DataCanvas):Sprite
Returns the Sprite associated with this layout if owner is in fact the owner of this layout.
AbstractLayout
 Inherited
invalidate():void
Notifies the DataCanvas that this layout needs to be rendered.
AbstractLayout
 Inherited
Iterates over the items in the dataProvider and stores them in dataItems.
AbstractLayout
 Inherited
registerOwner(dataCanvas:DataCanvas):void
Registers a DisplayObject as the owner of this layout.
AbstractLayout
 Inherited
render(newSprite:AxiisSprite = null):void
Draws this layout to the specified AxiisSprite, tracking all changes made by data binding or the referenceRepeater.
BaseLayout
Protected Methods
 MethodDefined By
 Inherited
Marks all children as deselected.
AbstractLayout
 Inherited
The callback method called by the referenceRepeater after it applies the PropertyModifiers on each iteration.
BaseLayout
 Inherited
The callback method called by the referenceRepeater before it applies the PropertyModifiers on each iteration.
BaseLayout
 Inherited
Calls the render method on all child layouts.
BaseLayout
 Inherited
The callback method called by the referenceRepeater after it finishes its final iteration.
BaseLayout
Events
 Event Summary Defined By
 InheritedDispatched when invalidate is called so the DataCanvas that owns this layout can being the process of redrawing the layout.BaseLayout
 InheritedDispatched when an AxiisSprite is clicked.BaseLayout
 InheritedDispatched when an AxiisSprite is mousedOver.BaseLayout
 InheritedDispatched when an AxiisSprite is double clicked.BaseLayout
 InheritedDispatched when an AxiisSprite is mousedOver.BaseLayout
 InheritedDispatched when an AxiisSprite is mousedOut.BaseLayout
 InheritedDispatched when an AxiisSprite is mousedOver.BaseLayout
 InheritedDispatched before each individual child is rendered.BaseLayout
 InheritedDispatched when an AxiisSprite is selectedBaseLayout
 InheritedDispatched when an AxiisSprite is unselectedBaseLayout
 InheritedDispatched at the beginning of the render method.BaseLayout
 InheritedDispatched when layout has completed its render cycleBaseLayout
Public Constants
 ConstantDefined 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
autoAdjustScaleproperty
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.

currentAxiisSpriteproperty 
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.

enableRollOverproperty 
public var enableRollOver:Boolean = false

Turns on/off the default roll-over state

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

fillproperty 
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.

horizontalScaleproperty 
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
markerColorproperty 
public var markerColor:Number

The color at the center of the markers.

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

markerSizeproperty 
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.

modeproperty 
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.

mouseOverFillproperty 
public var mouseOverFill:IGraphicsFill

The default fill to use for mouse over state.

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

mouseOverStrokeproperty 
public var mouseOverStroke:IGraphicsStroke

The default stroke to use for mouse over state.

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

plotCollectionproperty 
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.

plotCountproperty 
public var plotCount:Number

number of plots being mapped on x axis

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

plotFilterFunctionproperty 
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"

plotLabelFieldproperty 
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.

plotLabelFunctionproperty 
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.

seriesLabelFieldproperty 
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.

seriesPointsproperty 
seriesPoints:Array  [read-only]


Implementation
    public function get seriesPoints():Array
showAreaproperty 
public var showArea:Boolean

Whether the area beneath the lines should be filled.

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

showMarkerproperty 
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.

strokeproperty 
public var stroke:IGraphicsStroke

The stroke used to render the lines.

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

tensionproperty 
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.

verticalScaleproperty 
public var verticalScale:IScale

Vertical scale that is used by the LineSeriesGroup

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

xDataFieldproperty 
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_BASELINEConstant
public static const MODE_BASELINE:int = 0

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

MODE_STACK_FLOWConstant 
public static const MODE_STACK_FLOW:int = 2

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

MODE_STACK_ZEROConstant 
public static const MODE_STACK_ZERO:int = 1

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