package flare.vis.legend
{
import flare.display.RectSprite;
import flare.display.TextSprite;
import flare.scale.IScaleMap;
import flare.scale.Scale;
import flare.util.Colors;
import flare.util.Orientation;
import flare.util.Stats;
import flare.util.palette.ColorPalette;
import flash.display.GradientType;
import flash.display.Graphics;
import flash.display.Shape;
import flash.display.Sprite;
import flash.geom.Matrix;
import flash.geom.Rectangle;
import flash.text.TextFormat;
/**
* A range in a continuous legend, consisting of a continuous
* visual scale and value labels. Legend ranges use a
* <code>ColorPalette</code> instance for creating a gradient of
* color values. If the <code>stats</code> property
* is set with the <code>Stats</code> object for a backing data
* variable, a histogram of values will also be drawn in the legend
* range. To draw only a histogram, set the <code>palette</code>
* property to null.
*/
public class LegendRange extends RectSprite implements IScaleMap
{
private var _dataField:String;
private var _scale:Scale;
private var _stats:Stats;
private var _palette:ColorPalette;
private var _matrix:Matrix = new Matrix();
private var _margin:Number = 5;
private var _labels:Sprite;
private var _fmt:TextFormat;
private var _labelMode:int = TextSprite.BITMAP;
private var _range:Shape;
private var _rs:Number = 20;
private var _borderColor:uint = 0xcccccc;
private var _histogramColor:uint = 0x888888;
private var _orient:String;
private var _vert:Boolean;
private var _rev:Boolean;
/** The data field described by this legend range. */
public function get dataField():String { return _dataField; }
/** Sprite containing the range's labels. */
public function get labels():Sprite { return _labels; }
/** Stats object describing the data range. */
public function get stats():Stats { return _stats; }
public function set stats(s:Stats):void { _stats = s; dirty(); }
/** Text format (font, size, style) of legend range labels. */
public function get labelTextFormat():TextFormat { return _fmt; }
public function set labelTextFormat(fmt:TextFormat):void {
_fmt = fmt; dirty();
}
/** TextFormat (font, size, style) of legend range labels. */
public function get labelTextMode():int { return _labelMode; }
public function set labelTextMode(mode:int):void {
_labelMode = mode; dirty();
}
/** Margin value for padding within the legend item. */
public function get margin():Number { return _margin; }
public function set margin(m:Number):void {
_margin = m; dirty();
}
/** The size of the range, this is either the width or height of
* the range, depending on the current orientation. */
public function get rangeSize():Number { return _rs; }
public function set rangeSize(s:Number):void { _rs = s; }
/** The color of the legend range border. */
public function get borderColor():uint { return _borderColor; }
public function set borderColor(c:uint):void {
if (c != _borderColor) { _borderColor = c; dirty(); }
}
/** The color of bars in a generated histogram. */
public function get histogramColor():uint { return _histogramColor; }
public function set histogramColor(c:uint):void {
if (c == _histogramColor) return;
_histogramColor = c;
if (_stats) dirty();
}
/** The desired orientation of this legend range. */
public function get orientation():String { return _orient; }
public function set orientation(o:String):void {
_orient = o;
_vert = Orientation.isVertical(o);
_rev = o==Orientation.RIGHT_TO_LEFT || o==Orientation.BOTTOM_TO_TOP;
dirty();
}
/**
* Creates a new LegendRange.
* @param dataField the data field described by this range
* @param palette the color palette for the data field
* @param scale the Scale instance mapping the data field to a visual
* variable
*/
public function LegendRange(dataField:String, scale:Scale,
palette:ColorPalette=null,
orientation:String=Orientation.LEFT_TO_RIGHT)
{
_dataField = dataField;
_palette = palette;
_scale = scale;
this.orientation = orientation;
addChild(_range = new Shape());
addChild(_labels = new Sprite());
_range.cacheAsBitmap = true;
}
/** @inheritDoc */
public function get x1():Number {
return _vert || !_rev ? _margin : _w-_margin;
}
/** @inheritDoc */
public function get x2():Number {
return _vert ? _margin+_rs : (_rev ? _margin : _w-_margin);
}
/** @inheritDoc */
public function get y1():Number {
return _vert && !_rev ? _h-_margin : _margin;
}
/** @inheritDoc */
public function get y2():Number {
return _vert ? (_rev ? _h-_margin : _margin) : _margin+_rs;
}
private var _bounds:Rectangle = new Rectangle();
/**
* Bounds for the visual range portion of this legend range.
* @return the bounds of the range display
*/
public function get bounds():Rectangle {
_bounds.x = x1;
_bounds.y = y1;
_bounds.width = x2 - x1;
_bounds.height = y2 - y1;
return _bounds;
}
/** @inheritDoc */
public function value(x:Number, y:Number, stayInBounds:Boolean=true):Object
{
var f:Number;
if (_vert) {
f = (y-_margin) / (_h - 2*_margin);
} else {
f = (x-_margin) / (_w - 2*_margin);
}
if (stayInBounds) {
if (f < 0) f = 0;
if (f > 1) f = 1;
}
if (_rev) f = 1-f;
return _scale.lookup(f);
}
/** @inheritDoc */
public function X(val:Object):Number
{
return x1 + (_vert ? 0 : _scale.interpolate(val) * (x2 - x1));
}
/** @inheritDoc */
public function Y(val:Object):Number
{
return y1 + (_vert ? _scale.interpolate(val) * (y2-y1) : y1);
}
/**
* Update the labels shown by this legend range.
*/
public function updateLabels():void
{
var pts:Array = _palette==null ? [0,1] : _palette.keyframes;
var n:uint = pts.length;
for (var i:uint=_labels.numChildren; i<n; ++i) {
_labels.addChild(new TextSprite());
}
for (i=_labels.numChildren; --i>=n;) {
_labels.removeChildAt(i);
}
for (i=0; i<n; ++i) {
var ts:TextSprite = TextSprite(_labels.getChildAt(i));
var val:Object = _scale.lookup(pts[i]);
if (_fmt != null) ts.applyFormat(_fmt);
ts.textMode = _labelMode;
ts.text = _scale.label(val);
var j:uint = _vert==_rev ? i : n-i-1;
ts.horizontalAnchor = _vert || j==0 ? TextSprite.LEFT :
j==n-1 ? TextSprite.RIGHT : TextSprite.CENTER;
ts.verticalAnchor = !_vert || j==0 ? TextSprite.TOP :
j==n-1 ? TextSprite.BOTTOM : TextSprite.MIDDLE;
ts.x = _vert ? x2 : X(val);
ts.y = _vert ? Y(val) : y2;
var offset:Number = ts.height / 5;
if (_vert) {
ts.x += offset;
ts.y += j==0 ? -offset/2 : (j==n-1 ? offset : 0);
} else if (j==n-1) {
ts.x += offset/2;
}
ts.render();
}
}
/** @inheritDoc */
public override function render():void
{
updateLabels();
var w:Number = _vert ? _rs : _w - 2*_margin;
var h:Number = _vert ? _h - 2*_margin : _rs;
_range.x = _margin;
_range.y = _margin;
_h = _vert ? _h : 2*margin + h + _labels.height;
_range.graphics.clear();
if (_palette != null)
drawPalette(w, h);
if (_stats != null)
drawHistogram(w, h);
_range.graphics.lineStyle(0, _borderColor);
_range.graphics.drawRect(0, 0, w, h);
}
/**
* Draws a histogram of data values in the range dispay.
* @param w the width of the range display
* @param h the height of the range display
*/
protected function drawHistogram(w:Number, h:Number):void
{
var values:Array = _stats.values;
var ib:int = int(_vert ? h/2 : w/2);
var pb:int = (_vert ? h : w) / ib;
var d:Number = _vert ? w : h;
var i:int, f:Number;
var counts:Array = new Array(ib);
for (i=0; i<counts.length; ++i) counts[i] = 0;
for (i=0; i<values.length; ++i) {
f = _scale.interpolate(values[i]);
var idx:int = int(Math.round(f*(ib-1)));
counts[idx]++;
}
var max:Number = 0;
for (i=0; i<counts.length; ++i) {
if (counts[i] > max) max = counts[i];
}
max = d / (1.1*max);
var g:Graphics = _range.graphics;
g.beginFill(_histogramColor, _palette ? 0.5 : 1);
for (i=0; i<ib; ++i) {
var j:int = _vert==_rev ? i : ib-i-1;
if (_vert)
g.drawRect(w, h*i/ib, -max*counts[j], pb);
else
g.drawRect(w*i/ib, h, pb, -max*counts[j]);
}
g.endFill();
}
/**
* Draws a continuous color range in the range display.
* @param w the width of the range display
* @param h the height of the range display
*/
protected function drawPalette(w:Number, h:Number):void
{
var N:int = _palette.keyframes.length;
var colors:Array = new Array(N);
var alphas:Array = new Array(N);
var ratios:Array = new Array(N);
for (var i:uint=0; i<N; ++i) {
var c:uint = _palette.getColor(_palette.keyframes[i]);
colors[i] = 0x00ffffff & c;
alphas[i] = Colors.a(c) / 255;
ratios[i] = int(255 * _palette.keyframes[i]);
}
var rot:Number = _vert ? (_rev ? 1 : -1) * Math.PI/2
: (_rev ? Math.PI : 0);
_matrix.createGradientBox(w, h, rot);
var g:Graphics = _range.graphics;
g.beginGradientFill(GradientType.LINEAR,
colors, alphas, ratios, _matrix);
g.drawRect(0, 0, w, h);
g.endFill();
}
} }