Class to represent a labeled 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:
Because it is not always possible to fit all labels in a chart you may define the count of labels drawn using the $labelCount option. For all other labels only a small step will be rendered.
The labeled axis may be used like:
Source for this file: /Graph/src/axis/labeled.php
ezcBaseOptions | --ezcGraphChartElement | --ezcGraphChartElementAxis | --ezcGraphChartElementLabeledAxis
Version: | //autogentag// |
MAX_LABEL_COUNT
= 10
|
Maximum count of labels which can be displayed on one axis |
float | read/write |
$labelCount
Define count of displayed labels on the axis |
protected array |
$displayedLabels
= array()
Reduced amount of labels which will be displayed in the chart |
protected array |
$labels
= array()
Array with labeles for data |
protected array |
$labelsIndexed
= array()
Labels indexed by their name as key for faster lookups |
protected array(ezcGraphAxisStep) |
$steps
Precalculated 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 |
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 |
public array( |
getSteps(
)
Return array of steps on this axis |
protected array |
increaseKeys(
$array
, $startKey
)
Increase the keys of all elements in the array up from the start key, to insert an additional element at the correct position. |
public bool |
isZeroStep(
$step
)
Is zero step |
public void |
provideLabels(
$labels
)
Provide initial set of labels |
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 |
Get coordinate for a dedicated value on the chart
Name | Type | Description |
---|---|---|
$value |
string | 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 |
Return array of steps on this axis
Method | Description |
---|---|
ezcGraphChartElementAxis::getSteps() |
Return array of steps on this axis |
Increase the keys of all elements in the array up from the start key, to insert an additional element at the correct position.
Name | Type | Description |
---|---|---|
$array |
array | Array |
$startKey |
int | Key to increase keys from |
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 |
Provide initial set of labels
This method may be used to provide an ordered set of labels, containing labels, which are not available in the datasets or to provide a label order different to the one in the given dataset.
Name | Type | Description |
---|---|---|
$labels |
array |