Packageflare.vis.operator.layout
Classpublic class AxisLayout
InheritanceAxisLayout Inheritance Layout Inheritance Operator

Layout that places items along the X and Y axes according to data properties. The AxisLayout can also compute stacked layouts, in which elements that share the same data values along an axis are consecutively stacked on top of each other.



Public Properties
 PropertyDefined by
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
 InheritedlayoutAnchor : Point
The layout anchor, used by some layout instances to place an initial item or determine a focal point.
Layout
 InheritedlayoutBounds : Rectangle
The layout bounds for the layout.
Layout
 InheritedlayoutRoot : DataSprite
The layout root, the root node for tree layouts.
Layout
 InheritedlayoutType : String = "null"
The type of layout and axes.
Layout
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
  xField : String
The x-axis source property.
AxisLayout
  xScale : ScaleBinding
The scale binding for the x-axis.
AxisLayout
  xStacked : Boolean
Flag indicating if values should be stacked according to their x-axis values.
AxisLayout
  yField : String
The y-axis source property.
AxisLayout
  yScale : ScaleBinding
The scale binding for the y-axis.
AxisLayout
  yStacked : Boolean
Flag indicating if values should be stacked according to their y-axis values.
AxisLayout
Protected Properties
 PropertyDefined by
 Inherited_anchor : Point
Layout
 Inherited_setAnchor : Boolean = false
Layout
 Inherited_t : Transitioner = null
A transitioner for storing value updates.
Layout
  _xBinding : ScaleBinding
AxisLayout
  _xField : Property
AxisLayout
  _xStacks : Boolean = false
AxisLayout
 InheritedxyAxes : CartesianAxes
Returns the visualization's axes as a CartesianAxes instance.
Layout
  _yBinding : ScaleBinding
AxisLayout
  _yField : Property
AxisLayout
  _yStacks : Boolean = false
AxisLayout
Public Methods
 MethodDefined by
  
AxisLayout(xAxisField:String = null, yAxisField:String = null, xStacked:Boolean = false, yStacked:Boolean = false)
Creates a new AxisLayout
AxisLayout
 Inherited
applyParameters(op:IOperator, params:Object):void
[static] Static method that applies parameter settings to an operator.
Operator
 Inherited
Strips all EdgeSprites in a visualization of any control points.
Layout
 Inherited
Hides the axes.
Layout
 Inherited
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
Layout
  
setup():void
Setup method invoked whenever this operator's visualization property is set.
AxisLayout
 Inherited
Reveals the axes.
Layout
 Inherited
[static] Updates all edges to be straight lines.
Layout
Protected Methods
 MethodDefined by
 Inherited
autoAnchor():void
Automatically-generate an anchor point.
Layout
  
layout():void
Calculates the spatial layout of visualized items.
AxisLayout
 Inherited
minAngle(a1:Number, a2:Number):Number
Returns an angle value that minimizes the angular distance between a reference angle and a target angle.
Layout
Public Constants
 ConstantDefined by
 InheritedCARTESIAN : String = "cartesian"
[static] Constant indicating Cartesian (x, y) coordinates.
Layout
 InheritedPOLAR : String = "polar"
[static] Constant indicating polar (radius, angle) coordinates.
Layout
Property detail
_xBindingproperty
protected var _xBinding:ScaleBinding
_xFieldproperty 
protected var _xField:Property
xFieldproperty 
xField:String  [read-write]

The x-axis source property.

Implementation
    public function get xField():String
    public function set xField(value:String):void
xScaleproperty 
xScale:ScaleBinding  [read-write]

The scale binding for the x-axis.

Implementation
    public function get xScale():ScaleBinding
    public function set xScale(value:ScaleBinding):void
xStackedproperty 
xStacked:Boolean  [read-write]

Flag indicating if values should be stacked according to their x-axis values.

Implementation
    public function get xStacked():Boolean
    public function set xStacked(value:Boolean):void
_xStacksproperty 
protected var _xStacks:Boolean = false
_yBindingproperty 
protected var _yBinding:ScaleBinding
_yFieldproperty 
protected var _yField:Property
yFieldproperty 
yField:String  [read-write]

The y-axis source property.

Implementation
    public function get yField():String
    public function set yField(value:String):void
yScaleproperty 
yScale:ScaleBinding  [read-write]

The scale binding for the y-axis.

Implementation
    public function get yScale():ScaleBinding
    public function set yScale(value:ScaleBinding):void
yStackedproperty 
yStacked:Boolean  [read-write]

Flag indicating if values should be stacked according to their y-axis values.

Implementation
    public function get yStacked():Boolean
    public function set yStacked(value:Boolean):void
_yStacksproperty 
protected var _yStacks:Boolean = false
Constructor detail
AxisLayout()constructor
public function AxisLayout(xAxisField:String = null, yAxisField:String = null, xStacked:Boolean = false, yStacked:Boolean = false)

Creates a new AxisLayout

Parameters
xAxisField:String (default = null) — the x-axis source property
 
yAxisField:String (default = null) — the y-axis source property
 
xStacked:Boolean (default = false) — indicates if values should be stacked according to their x-axis values
 
yStacked:Boolean (default = false) — indicates if values should be stacked according to their y-axis values
Method detail
layout()method
protected override function layout():void

Calculates the spatial layout of visualized items. Layout operators override this method with their layout implementations.

setup()method 
public override function setup():void

Setup method invoked whenever this operator's visualization property is set.