| Package | flare.vis.operator.layout |
| Class | public class CircleLayout |
| Inheritance | CircleLayout  Layout Operator |
treeLayout
property is set to true, the layout will use an
underlying tree structure to layout the data. Leaf nodes will be
placed along the circumference of the circle, but parent nodes will
be placed in the interior. Also, the layout will add spacing to
differentiate sibling groups along the circumference.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.
| Property | Defined 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 | ||
 | enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
| layoutAnchor : Point The layout anchor, used by some layout instances to place an
initial item or determine a focal point.
| Layout | |
| layoutBounds : Rectangle The layout bounds for the layout.
| Layout | |
| layoutRoot : DataSprite
The layout root, the root node for tree layouts.
| Layout | |
| layoutType : String = "null" The type of layout and axes.
| Layout | |
| padding : Number = 50 The padding around the circumference of the circle, in pixels.
| CircleLayout | ||
| parameters : 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 | ||
| visualization : Visualization
The visualization processed by this operator.
| Operator | |
| Property | Defined by | ||
|---|---|---|---|
| _aBinding : ScaleBinding | CircleLayout | ||
| _aField : Property | CircleLayout | ||
| _anchor : Point | Layout | |
| _group : String | CircleLayout | ||
| _inner : Number = 0 | CircleLayout | ||
| _outer : Number | CircleLayout | ||
| _rBinding : ScaleBinding | CircleLayout | ||
| _rField : Property | CircleLayout | ||
| _setAnchor : Boolean = false | Layout | |
| _t : Transitioner = null A transitioner for storing value updates.
| Layout | |
| xyAxes : CartesianAxes
Returns the visualization's axes as a CartesianAxes instance.
| Layout | |
| Method | Defined by | ||
|---|---|---|---|
|
CircleLayout(radiusField:String = null, angleField:String = null, treeLayout:Boolean = false, group:String)
Creates a new CircleLayout.
| CircleLayout | ||
|
applyParameters(op:IOperator, params:Object):void
[static]
Static method that applies parameter settings to an operator.
| Operator | |
|
clearEdgePoints():void
Strips all EdgeSprites in a visualization of any control points.
| Layout | |
|
Hides the axes.
| Layout | |
|
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 | ||
|
Reveals the axes.
| Layout | |
|
[static]
Updates all edges to be straight lines.
| Layout | |
| Method | Defined by | ||
|---|---|---|---|
|
autoAnchor():void
Automatically-generate an anchor point.
| Layout | |
|
layout():void
Calculates the spatial layout of visualized items.
| CircleLayout | ||
|
minAngle(a1:Number, a2:Number):Number
Returns an angle value that minimizes the angular distance
between a reference angle and a target angle.
| Layout | |
| _aBinding | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _aBinding:ScaleBinding
| _aField | property |
protected var _aField:Property
| angleField | property |
angleField:String [read-write]The angle source property.
Implementation public function get angleField():String
public function set angleField(value:String):void
| angleScale | property |
angleScale:ScaleBinding [read-write]The scale binding for the angle.
Implementation public function get angleScale():ScaleBinding
public function set angleScale(value:ScaleBinding):void
| angleWidth | property |
public var angleWidth:NumberThe angular width of the layout, in radians (default is 2 pi).
| _group | property |
protected var _group:String
| _inner | property |
protected var _inner:Number = 0
| _outer | property |
protected var _outer:Number
| padding | property |
public var padding:Number = 50The padding around the circumference of the circle, in pixels.
| radiusField | property |
radiusField:String [read-write]The radius source property.
Implementation public function get radiusField():String
public function set radiusField(value:String):void
| radiusScale | property |
radiusScale:ScaleBinding [read-write]The scale binding for the radius.
Implementation public function get radiusScale():ScaleBinding
public function set radiusScale(value:ScaleBinding):void
| _rBinding | property |
protected var _rBinding:ScaleBinding
| _rField | property |
protected var _rField:Property
| startAngle | property |
public var startAngle:NumberThe starting angle for the layout, in radians.
| startRadius | property |
startRadius:Number [read-write] The starting (inner) radius at which to place items.
Setting this value also overrides the
startRadiusFraction property.
public function get startRadius():Number
public function set startRadius(value:Number):void
| startRadiusFraction | property |
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.
public function get startRadiusFraction():Number
public function set startRadiusFraction(value:Number):void
| treeLayout | property |
public var treeLayout:Boolean = falseFlag indicating if tree structure should inform the layout.
| CircleLayout | () | constructor |
public function CircleLayout(radiusField:String = null, angleField:String = null, treeLayout:Boolean = false, group:String)Creates a new CircleLayout.
ParametersradiusField:String (default = null) |
|
angleField:String (default = null) |
|
treeLayout:Boolean (default = false) |
|
group:String — the data group to process. If tree layout is set to
true, this value may get ignored.
|
| layout | () | method |
protected override function layout():voidCalculates the spatial layout of visualized items. Layout operators override this method with their layout implementations.
| setup | () | method |
public override function setup():voidSetup method invoked whenever this operator's visualization property is set.