Packageflare.vis.operator.layout
Classpublic class CircleLayout
InheritanceCircleLayout Inheritance Layout Inheritance Operator

Layout that places items in a circular layout. This operator is quite flexible and offers a number of layout options:

The layout also supports mixes of the above modes. For example, if treeLayout is set to true and a data field for the radius is set, the angles in the layout will be determined as in a normal ciruclar tree layout, but the radius values will be derived using the data field.



Public Properties
 PropertyDefined by
  angleField : String
The angle source property.
CircleLayout
  angleScale : ScaleBinding
The scale binding for the angle.
CircleLayout
  angleWidth : Number
The angular width of the layout, in radians (default is 2 pi).
CircleLayout
 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
  padding : Number = 50
The padding around the circumference of the circle, in pixels.
CircleLayout
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
  radiusField : String
The radius source property.
CircleLayout
  radiusScale : ScaleBinding
The scale binding for the radius.
CircleLayout
  startAngle : Number
The starting angle for the layout, in radians.
CircleLayout
  startRadius : Number
The starting (inner) radius at which to place items.
CircleLayout
  startRadiusFraction : Number
The starting (inner) radius as a fraction of the outer radius.
CircleLayout
  treeLayout : Boolean = false
Flag indicating if tree structure should inform the layout.
CircleLayout
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Protected Properties
 PropertyDefined by
  _aBinding : ScaleBinding
CircleLayout
  _aField : Property
CircleLayout
 Inherited_anchor : Point
Layout
  _group : String
CircleLayout
  _inner : Number = 0
CircleLayout
  _outer : Number
CircleLayout
  _rBinding : ScaleBinding
CircleLayout
  _rField : Property
CircleLayout
 Inherited_setAnchor : Boolean = false
Layout
 Inherited_t : Transitioner = null
A transitioner for storing value updates.
Layout
 InheritedxyAxes : CartesianAxes
Returns the visualization's axes as a CartesianAxes instance.
Layout
Public Methods
 MethodDefined by
  
CircleLayout(radiusField:String = null, angleField:String = null, treeLayout:Boolean = false, group:String)
Creates a new CircleLayout.
CircleLayout
 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.
CircleLayout
 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.
CircleLayout
 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
_aBindingproperty
protected var _aBinding:ScaleBinding
_aFieldproperty 
protected var _aField:Property
angleFieldproperty 
angleField:String  [read-write]

The angle source property.

Implementation
    public function get angleField():String
    public function set angleField(value:String):void
angleScaleproperty 
angleScale:ScaleBinding  [read-write]

The scale binding for the angle.

Implementation
    public function get angleScale():ScaleBinding
    public function set angleScale(value:ScaleBinding):void
angleWidthproperty 
public var angleWidth:Number

The angular width of the layout, in radians (default is 2 pi).

_groupproperty 
protected var _group:String
_innerproperty 
protected var _inner:Number = 0
_outerproperty 
protected var _outer:Number
paddingproperty 
public var padding:Number = 50

The padding around the circumference of the circle, in pixels.

radiusFieldproperty 
radiusField:String  [read-write]

The radius source property.

Implementation
    public function get radiusField():String
    public function set radiusField(value:String):void
radiusScaleproperty 
radiusScale:ScaleBinding  [read-write]

The scale binding for the radius.

Implementation
    public function get radiusScale():ScaleBinding
    public function set radiusScale(value:ScaleBinding):void
_rBindingproperty 
protected var _rBinding:ScaleBinding
_rFieldproperty 
protected var _rField:Property
startAngleproperty 
public var startAngle:Number

The starting angle for the layout, in radians.

startRadiusproperty 
startRadius:Number  [read-write]

The starting (inner) radius at which to place items. Setting this value also overrides the startRadiusFraction property.

Implementation
    public function get startRadius():Number
    public function set startRadius(value:Number):void
startRadiusFractionproperty 
startRadiusFraction:Number  [read-write]

The starting (inner) radius as a fraction of the outer radius. Setting this value also overrides the startRadius property. When this property is set to NaN, the current value of startRadius will be used directly.

Implementation
    public function get startRadiusFraction():Number
    public function set startRadiusFraction(value:Number):void
treeLayoutproperty 
public var treeLayout:Boolean = false

Flag indicating if tree structure should inform the layout.

Constructor detail
CircleLayout()constructor
public function CircleLayout(radiusField:String = null, angleField:String = null, treeLayout:Boolean = false, group:String)

Creates a new CircleLayout.

Parameters
radiusField:String (default = null) — optional data field to encode as radius length
 
angleField:String (default = null) — optional data field to encode as angle
 
treeLayout:Boolean (default = false) — boolean flag indicating if any tree-structure in the data should be used to inform the layout
 
group:String — the data group to process. If tree layout is set to true, this value may get ignored.
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.