Main Page | Packages | Class Tree | Index | Help

xp.charting.descriptors

class AxisDesc

Object
  |
  +--xp.charting.descriptors.AxisDesc

All Known Subclasses: XAxis, YAxis

class AxisDesc
extends Object

Axis Descriptor


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
autoScale: Boolean
will extents be scaled automatically

public
axislineStyle: Object
axis line style


AxisSpacing: Array


public
chartParent: Object


public
drawGridlines: Boolean
should the gridline sbe drawn for this axis

public
forceZero: Boolean
Used to set the minimum value of a numerical axis to zero even if the data minimum value does not start at zero.

public
format: String
format string for format labels

public
gridlineStyle: Object
grid line style dimension

public
isStacked: Boolean
is this axis measuring stacked series data

public
labelAngle: Number
the angle to display labels

public
labelOffest: Number
the distance between the label and the axis

public
labels: Array
array of axis label descriptors

public
labelStyle: Object
style object to apply to labels

public
maxValue: Number
axis min value

public
minorStepCount: Number
Specifies the increment you want between minor tick marks and minor gridlines (if they are displayed) on the selected axis

public
minorTickMark: Number
Allows you to get or set the style for tick marks at the minor gridlines on the selected axis.

public
minValue: Number
axis max value

public
numLabels: Number
num of labels displayed

public
placement: String
placement of axis left/right/top/bottom

public
prefix: String
first label prefix

public
primary: Boolean
is this the primary axis

public
scale: Number
scale factor from data to pixels

public
scaleUnit
Returns or sets the scale unit of a selected axis.

public
series: Object
the data series that this axis will calibrate

public
showAxisLabels: Boolean
should we display labels on the axis

public
step: Number
Specifies the interval of major tick marks, labels and gridlines on the selected axis

public
suffix: String
first label suffix

public
tickMark: Number
Allows you to set the style for tick marks at the major gridlines on the selected axis

public
tickMarkStyle: Object
tick mark line style dimension

Constructor

public
AxisDesc ( axis: MovieClip, grid: MovieClip, lineColor: Number, maxValue: Number, minValue: Number, numLabels: Number, type: Number)
Create a new Axis descriptor instance

Method Summary

public
adjustScale ( )
Adjusts the selected axis to "nice" scale values

public
pixelToValue ( pixel: Number ): Number
Converts a position in pixels in the chart area to its representation on the selected axis.

public
resetScale ( )
Prepares the selected axis for new data by resetting scale values

public
setAttributes ( desc: Object )
Update a descriptor

public
valueToPixel ( value: Number ): Number
Converts a value to its position in pixels on a selected axis.



Field Documentation

autoScale

public var autoScale: Boolean
will extents be scaled automatically

axislineStyle

public var axislineStyle: Object
axis line style

AxisSpacing

var AxisSpacing: Array

chartParent

public var chartParent: Object

drawGridlines

public var drawGridlines: Boolean
should the gridline sbe drawn for this axis

forceZero

public var forceZero: Boolean
Used to set the minimum value of a numerical axis to zero even if the data minimum value does not start at zero.

format

public var format: String
format string for format labels

gridlineStyle

public var gridlineStyle: Object
grid line style dimension

isStacked

public var isStacked: Boolean
is this axis measuring stacked series data

labelAngle

public var labelAngle: Number
the angle to display labels

labelOffest

public var labelOffest: Number
the distance between the label and the axis

labels

public var labels: Array
array of axis label descriptors

labelStyle

public var labelStyle: Object
style object to apply to labels

maxValue

public var maxValue: Number
axis min value

minorStepCount

public var minorStepCount: Number
Specifies the increment you want between minor tick marks and minor gridlines (if they are displayed) on the selected axis

minorTickMark

public var minorTickMark: Number
Allows you to get or set the style for tick marks at the minor gridlines on the selected axis.

minValue

public var minValue: Number
axis max value

numLabels

public var numLabels: Number
num of labels displayed

placement

public var placement: String
placement of axis left/right/top/bottom

prefix

public var prefix: String
first label prefix

primary

public var primary: Boolean
is this the primary axis

scale

public var scale: Number
scale factor from data to pixels

scaleUnit

public var scaleUnit
Returns or sets the scale unit of a selected axis.

series

public var series: Object
the data series that this axis will calibrate

showAxisLabels

public var showAxisLabels: Boolean
should we display labels on the axis

step

public var step: Number
Specifies the interval of major tick marks, labels and gridlines on the selected axis

suffix

public var suffix: String
first label suffix

tickMark

public var tickMark: Number
Allows you to set the style for tick marks at the major gridlines on the selected axis

tickMarkStyle

public var tickMarkStyle: Object
tick mark line style dimension


Constructor Documentation

AxisDesc

public function AxisDesc(axis: MovieClip,
 grid: MovieClip,
 lineColor: Number,
 maxValue: Number,
 minValue: Number,
 numLabels: Number,
 type: Number)
Create a new Axis descriptor instance


Method Documentation

adjustScale

public function adjustScale()
Adjusts the selected axis to "nice" scale values

pixelToValue

public function pixelToValue(pixel: Number): Number
Converts a position in pixels in the chart area to its representation on the selected axis.

resetScale

public function resetScale()
Prepares the selected axis for new data by resetting scale values

setAttributes

public function setAttributes(desc: Object)
Update a descriptor

Updates an axis desc with the properties in the desc param

valueToPixel

public function valueToPixel(value: Number): Number
Converts a value to its position in pixels on a selected axis.


The documentation was generated from the following file:


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