[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcGraphChartElementNumericAxis

Class to represent a numeric axis. The axis tries to calculate "nice" start and end values for the axis scale. The used interval is considered as nice, if it is equal to [1,2,5] * 10^x with x in [.., -1, 0, 1, ..]. [source]

Parents

ezcBaseOptions
   |
   --ezcGraphChartElement
      |
      --ezcGraphChartElementAxis
         |
         --ezcGraphChartElementNumericAxis

Constants

MIN_MAJOR_COUNT = 5	Constant used for calculation of automatic definition of major scaling steps
MIN_MINOR_COUNT = 8	Constant used for automatic calculation of minor steps from given major steps

Properties

float	read/write	$max Maximum value of displayed scale on axis.
float	read	$maxValue Maximum value to display on this axis.
float	read/write	$min Minimum value of displayed scale on axis.
float	read	$minValue Minimum Value to display on this axis.

Inherited Member Variables

From ezcGraphChartElementAxis:

protected

ezcGraphChartElementAxis::$axisLabelRenderer

From ezcBaseOptions:

protected

ezcBaseOptions::$properties

Method Summary

public void	addData( $values ) Add data for this axis
public abstract void	calculateAxisBoundings( ) Calculate axis bounding values on base of the assigned values
protected void	calculateMajorStep( $min, $max ) Calculate size of major step based on the span to be displayed and the defined MIN_MAJOR_COUNT constant.
protected void	calculateMaximum( $min, $max ) Calculate maximum value for displayed axe basing on real maximum and major step size
protected void	calculateMinimum( $min, $max ) Calculate minimum value for displayed axe basing on real minimum and major step size
protected void	calculateMinorStep( $min, $max ) Calculate size of minor steps based on the size of the major step size
public float	getCoordinate( $value ) Get coordinate for a dedicated value on the chart
public string	getLabel( $step ) Get label for a dedicated step on the axis
public integer	getMajorStepCount( ) Return count of major steps
public integer	getMinorStepCount( ) Return count of minor steps
protected float	getNiceNumber( $float ) Returns a "nice" number for a given floating point number.
public bool	isZeroStep( $step ) Is zero step

Inherited Methods

From ezcGraphChartElementAxis :

public abstract void	ezcGraphChartElementAxis::addData() Add data for this axis
public abstract void	ezcGraphChartElementAxis::calculateAxisBoundings() Calculate axis bounding values on base of the assigned values
public abstract float	ezcGraphChartElementAxis::getCoordinate() Get coordinate for a dedicated value on the chart
public abstract string	ezcGraphChartElementAxis::getLabel() Get label for a dedicated step on the axis
public abstract integer	ezcGraphChartElementAxis::getMajorStepCount() Return count of major steps
public abstract integer	ezcGraphChartElementAxis::getMinorStepCount() Return count of minor steps
public array(	ezcGraphChartElementAxis::getSteps() Return array of steps on this axis
public abstract bool	ezcGraphChartElementAxis::isZeroStep() Is zero step
public ezcGraphBoundings	ezcGraphChartElementAxis::render() Render the axis
public void	ezcGraphChartElementAxis::setFromPalette() Set colors and border fro this element
public void	ezcGraphChartElementAxis::__set() __set

From ezcGraphChartElement :

protected ezcGraphBoundings	ezcGraphChartElement::getTitleSize() Returns calculated boundings based on available percentual space of given bounding box specified in the elements options and direction of the box.
public abstract ezcGraphBoundings	ezcGraphChartElement::render() Renders this chart element
public void	ezcGraphChartElement::setFromPalette() Set colors and border fro this element

From ezcBaseOptions :

public ezcBaseOptions	ezcBaseOptions::__construct() Construct a new options object.
public void	ezcBaseOptions::merge() Merge an array into the actual options object.
public bool	ezcBaseOptions::offsetExists() Returns if an option exists.
public mixed	ezcBaseOptions::offsetGet() Returns an option value.
public void	ezcBaseOptions::offsetSet() Set an option.
public void	ezcBaseOptions::offsetUnset() Unset an option.

Methods

addData

Parameters

Name	Type	Description
$values	array	Value which will be displayed on this axis

Redefinition of

Method	Description
ezcGraphChartElementAxis::addData()	Add data for this axis

calculateAxisBoundings

Redefinition of

Method	Description
ezcGraphChartElementAxis::calculateAxisBoundings()	Calculate axis bounding values on base of the assigned values

calculateMajorStep

Parameters

Name	Type	Description
$min	float	Real data minimum
$max	float	Real data maximum

calculateMaximum

Parameters

Name	Type	Description
$min	float	Real data minimum
$max	float	Real data maximum

calculateMinimum

Parameters

Name	Type	Description
$min	float	Real data minimum
$max	float	Real data maximum

calculateMinorStep

Parameters

Name	Type	Description
$min	float	Real data minimum
$max	float	Real data maximum

getCoordinate

Parameters

Name	Type	Description
$value	float	Value to determine position for

Redefinition of

Method	Description
ezcGraphChartElementAxis::getCoordinate()	Get coordinate for a dedicated value on the chart

getLabel

Parameters

Name	Type	Description
$step	integer	Number of step

Redefinition of

Method	Description
ezcGraphChartElementAxis::getLabel()	Get label for a dedicated step on the axis

getMajorStepCount

Redefinition of

Method	Description
ezcGraphChartElementAxis::getMajorStepCount()	Return count of major steps

getMinorStepCount

Redefinition of

Method	Description
ezcGraphChartElementAxis::getMinorStepCount()	Return count of minor steps

getNiceNumber

Parameters

Name	Type	Description
$float	float	Number to be altered

isZeroStep

Parameters

Name	Type	Description
$step	int	Number of step

Redefinition of

Method	Description
ezcGraphChartElementAxis::isZeroStep()	Is zero step