| Package | flare.vis.operator.label |
| Class | public class StackedAreaLabeler |
| Inheritance | StackedAreaLabeler  Labeler Operator |
StackedAreaLayout operator. Adds labels to stacks whose
maximum height in pixels exceeds the minimum threshold
value.
NOTE: This has only been tested for use with horizontally oriented stacks. In the future, this will be extended to work with vertically oriented stacks as well.
| Property | Defined by | ||
|---|---|---|---|
 | access : String The name of the property in which to store created labels.
| Labeler | |
| baseSize : int = 6 The base (minimum) size for labels.
| StackedAreaLabeler | ||
| cacheText : Boolean Boolean function indicating whether label text values should be
cached or not.
| Labeler | |
| columnIndex : int = 2 Indicates the first column considered for label placement.
| StackedAreaLabeler | ||
| enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
| filter : Function Boolean function indicating which items to process.
| Labeler | |
| group : String The name of the data group to label.
| Labeler | |
| horizontalAnchor : int = 1 The horizontal alignment for labels.
| Labeler | |
| labelPolicy : String The policy for how labels should be applied.
| Labeler | |
| labels : Sprite A sprite containing the labels, if a layer policy is used.
| Labeler | |
| parameters : Object
Sets parameter values for this operator.
| Operator | |
| source : String The source property that provides the label text.
| Labeler | |
| textFormat : TextFormat The text format to apply to labels.
| Labeler | |
| textFunction : Function = null Optional function for determining label text.
| Labeler | |
| textMode : int = 2 The text mode to use for the TextSprite labels.
| Labeler | |
| threshold : Number = 12 The minimum width for a stack to receive a label (default 12).
| StackedAreaLabeler | ||
| verticalAnchor : int = 1 The vertical alignment for labels.
| Labeler | |
| visualization : Visualization
The visualization processed by this operator.
| Operator | |
| xOffset : Number = 0 The default
x value for labels. | Labeler | |
| yOffset : Number = 0 The default
y value for labels. | Labeler | |
| Method | Defined by | ||
|---|---|---|---|
|
StackedAreaLabeler(source:* = null, group:String)
Creates a new StackedAreaLabeler.
| StackedAreaLabeler | ||
|
applyParameters(op:IOperator, params:Object):void
[static]
Static method that applies parameter settings to an operator.
| Operator | |
|
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
| Labeler | |
|
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| Labeler | |
| Method | Defined by | ||
|---|---|---|---|
|
Retrives and optionally creates a label TextSprite for the given
data sprite.
| Labeler | |
|
getLabelText(d:DataSprite):String
Computes the label text for a given sprite.
| Labeler | |
|
process(d:DataSprite):void
Performs label creation and layout for the given data sprite.
| StackedAreaLabeler | ||
| baseSize | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var baseSize:int = 6The base (minimum) size for labels.
| columnIndex | property |
public var columnIndex:int = 2Indicates the first column considered for label placement. This prevents columns on the edges of the display from being labeled, as the labels might then bleed outside the display.
| threshold | property |
public var threshold:Number = 12The minimum width for a stack to receive a label (default 12).
| StackedAreaLabeler | () | constructor |
public function StackedAreaLabeler(source:* = null, group:String)Creates a new StackedAreaLabeler.
Parameterssource:* (default = null)textFunction |
|
group:String |
| process | () | method |
protected override function process(d:DataSprite):voidPerforms label creation and layout for the given data sprite. Subclasses should override this method to perform custom labeling.
Parametersd:DataSprite — the data sprite to process
|