Class to represent a numeric axis.
Axis elements represent the axis in a bar, line or radar chart. They are chart elements (ezcGraphChartElement) extending from ezcGraphChartElementAxis, where additional formatting options can be found. You should generally use the axis, which matches your input data best, so that the automatic chart layouting works best. Aavailable axis types are:
The start and end value are the next bigger / smaller multiple of the intervall compared to the maximum / minimum axis value.
You may specify custom step sizes using the properties $majorStep and $minorStep. The minimum and maximum values for the axis labels can be defined using the $min and $max properties. You should be able to set any subset of these values, and all values not explicitely set will be calculated automatically.
This axis should be used for all numeric values except dates. If your data does span very big number intervals you might want to consider using the logrithmic axis instead.
The numeric axis may be used like:
Source for this file: /Graph/src/axis/numeric.php
ezcBaseOptions | --ezcGraphChartElement | --ezcGraphChartElementAxis | --ezcGraphChartElementNumericAxis
Version: | //autogentag// |
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 |
mixed | read/write |
$majorStep
Labeled major steps displayed on the axis. |
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. |
mixed | read/write |
$minorStep
Non labeled minor steps on the axis. |
From ezcGraphChartElementAxis | |
---|---|
protected |
ezcGraphChartElementAxis::$axisLabelRenderer
|
protected |
ezcGraphChartElementAxis::$innerBoundings
|
From ezcBaseOptions | |
protected |
ezcBaseOptions::$properties
|
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 |
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. |
Add data for this axis
Name | Type | Description |
---|---|---|
$values |
array | Value which will be displayed on this axis |
Method | Description |
---|---|
ezcGraphChartElementAxis::addData() |
Add data for this axis |
Calculate axis bounding values on base of the assigned values
Method | Description |
---|---|
ezcGraphChartElementAxis::calculateAxisBoundings() |
Calculate axis bounding values on base of the assigned values |
Calculate size of major step based on the span to be displayed and the defined MIN_MAJOR_COUNT constant.
Name | Type | Description |
---|---|---|
$min |
float | Real data minimum |
$max |
float | Real data maximum |
Calculate maximum value for displayed axe basing on real maximum and major step size
Name | Type | Description |
---|---|---|
$min |
float | Real data minimum |
$max |
float | Real data maximum |
Calculate minimum value for displayed axe basing on real minimum and major step size
Name | Type | Description |
---|---|---|
$min |
float | Real data minimum |
$max |
float | Real data maximum |
Calculate size of minor steps based on the size of the major step size
Name | Type | Description |
---|---|---|
$min |
float | Real data minimum |
$max |
float | Real data maximum |
Get coordinate for a dedicated value on the chart
Name | Type | Description |
---|---|---|
$value |
float | Value to determine position for |
Method | Description |
---|---|
ezcGraphChartElementAxis::getCoordinate() |
Get coordinate for a dedicated value on the chart |
Get label for a dedicated step on the axis
Name | Type | Description |
---|---|---|
$step |
integer | Number of step |
Method | Description |
---|---|
ezcGraphChartElementAxis::getLabel() |
Get label for a dedicated step on the axis |
Return count of major steps
Method | Description |
---|---|
ezcGraphChartElementAxis::getMajorStepCount() |
Return count of major steps |
Return count of minor steps
Method | Description |
---|---|
ezcGraphChartElementAxis::getMinorStepCount() |
Return count of minor steps |
Returns a "nice" number for a given floating point number.
Nice numbers are steps on a scale which are easily recognized by humans like 0.5, 25, 1000 etc.
Name | Type | Description |
---|---|---|
$float |
float | Number to be altered |
Is zero step
Returns true if the given step is the one on the initial axis position
Name | Type | Description |
---|---|---|
$step |
int | Number of step |
Method | Description |
---|---|
ezcGraphChartElementAxis::isZeroStep() |
Is zero step |