Main Page | Packages | Class Tree | Index | Help

xp.charting

class Band

Object
  |
  +--xp.charting.Band


class Band
extends Object

Provides access to the Chart's band object

Band is one of the most useful objects when it comes to highlighting information in the chart area. They allow you to highlight a range of values associated with any of the axis by drawing a color frame in the chart background. Bands allow the user to easily pinpoint data that falls within a range of values associated with any of the axes. For example, in a scientific application you may want the user to recognize points that plot between 20 and 40 with a blue stripe object The range of the band (start, end) goes in strict relationship with the Axis scale that is related to, as follows:- If the band is related to a numerical axis, the band range (start and end) is defined according to the scale values set for that particular axis.For example creating a band for the Y axis is defined by two numbers. (i.e. start = 30.5 , end = 50.75)- If the band is related to a categorical axis (X axis in charts other than XY Plots), the range (start, end) is defined by numbers specifying the point range you want the band to cover.For example creating a band for the X axis is defined by two number (Point index) numbers. (i.e. If you want to create a color band from point = 3 to point = 10) The start value must be lesser than the end value. You can associate a band to an axis using the axis property. You can set the color of the band and its alpha with the fillColor and fillAlpha properties. If you want to highlight a particular value on an axis (instead of a range) you can use the Line class.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
axis: String
Used to associate the band with a specific chart axis

public
fillAlpha: Number
Used to set the alpha for the band

public
fillColor: Number
Used to set the color for the band

public
text: String
the label text to display with the band

public
valueEnd: Number
Used to set the ending value for the band

public
valueStart: Number
Used to set the starting value for the band

Constructor

public
Band ( axis: String, valueStart: Number, valueEnd: Number, fillColor: Number, fillAlpha: Number, text: String)


Method Summary

public
destroy ( )
removes this band from tha chart

public
init ( chartDesc: ChartDesc )
associates a band with a chart

public
render ( )
draws the band on the chart



Field Documentation

axis

public var axis: String
Used to associate the band with a specific chart axis

fillAlpha

public var fillAlpha: Number
Used to set the alpha for the band

fillColor

public var fillColor: Number
Used to set the color for the band

text

public var text: String
the label text to display with the band

valueEnd

public var valueEnd: Number
Used to set the ending value for the band

valueStart

public var valueStart: Number
Used to set the starting value for the band


Constructor Documentation

Band

public function Band(axis: String,
 valueStart: Number,
 valueEnd: Number,
 fillColor: Number,
 fillAlpha: Number,
 text: String)

Method Documentation

destroy

public function destroy()
removes this band from tha chart

init

public function init(chartDesc: ChartDesc)
associates a band with a chart

render

public function render()
draws the band on the chart


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc