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

PlotGroup renders circles of varying radii into a cartesian grid without the use of reference geometries. The circles can be styled with a fill and stroke and an optional highlight. Each circle can have a marker rendered at its center.



Public Properties
 PropertyDefined By
 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
 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
  defaultRadius : Number
The default radius to use when radiusField is not specified
PlotGroup
 InheriteddrawingGeometries : Array
An array of geometries that should be drawn for each item in the data provider.
AbstractLayout
 Inheritedfills : Array
A placeholder for fills used within this layout.
AbstractLayout
 Inheritedheight : Number
The height of the layout.
AbstractLayout
  highlightStroke : SolidStroke
The stroke applied to the highlight at the center of each circle.
PlotGroup
  horizontalField : String
The name of the property on the items in the dataProvider that contains the value that should be rendered along the horizontal axis.
PlotGroup
  horizontalScale : LinearScale
The scale used to translate data values to the layout's coordinate space in the horizontal direction.
PlotGroup
 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
  markerGeometry : Geometry
The geometry rendered at the center of each circle.
PlotGroup
 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
  plotFill : IGraphicsFill
The fill applied to the circles.
PlotGroup
  plotStroke : IGraphicsStroke
The stroke applied to the circles.
PlotGroup
  radiusField : String
The name of the property on the items in the dataProvider that contains the value that should used to determine the radius of each circle.
PlotGroup
  radiusScale : LogScale
The scale used to convert data values to radii.
PlotGroup
 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
 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
PlotGroup
 Inheritedstates : Array
An array of states that should be applied to this layout.
AbstractLayout
 Inheritedstrokes : Array
A placeholder for strokes used within this layout.
AbstractLayout
 InheriteduseHandCursor : Boolean = false
The value of the useHandCursor flag to set each child Sprite
BaseLayout
  verticalField : String
The name of the property on the items in the dataProvider that contains the value that should be rendered along the vertical axis.
PlotGroup
  verticalScale : LinearScale
The scale used to translate data values to the layout's coordinate space in the vertical direction.
PlotGroup
 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
 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
  
PlotGroup
 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
Property Detail
defaultRadiusproperty
public var defaultRadius:Number

The default radius to use when radiusField is not specified

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

highlightStrokeproperty 
public var highlightStroke:SolidStroke

The stroke applied to the highlight at the center of each circle.

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

horizontalFieldproperty 
public var horizontalField:String

The name of the property on the items in the dataProvider that contains the value that should be rendered along the horizontal axis.

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

horizontalScaleproperty 
public var horizontalScale:LinearScale

The scale used to translate data values to the layout's coordinate space in the horizontal direction.

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

markerGeometryproperty 
public var markerGeometry:Geometry

The geometry rendered at the center of each circle.

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

plotFillproperty 
public var plotFill:IGraphicsFill

The fill applied to the circles.

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

plotStrokeproperty 
public var plotStroke:IGraphicsStroke

The stroke applied to the circles.

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

radiusFieldproperty 
public var radiusField:String

The name of the property on the items in the dataProvider that contains the value that should used to determine the radius of each circle.

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

radiusScaleproperty 
public var radiusScale:LogScale

The scale used to convert data values to radii.

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.

verticalFieldproperty 
public var verticalField:String

The name of the property on the items in the dataProvider that contains the value that should be rendered along the vertical axis.

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

verticalScaleproperty 
public var verticalScale:LinearScale

The scale used to translate data values to the layout's coordinate space in the vertical direction.

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

Constructor Detail
PlotGroup()Constructor
public function PlotGroup()