Path

ez components / documentation / api reference / 2006.2 / graph

eZ Components 2006.2

Graph: ezcGraphChartElementDateAxis

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

Class: ezcGraphChartElementDateAxis

Class to represent date axis. Date axis will try to find a "nice" interval based on the values on the x axis. If non numeric values are given, ezcGraphChartElementDateAxis will convert them to timestamps using PHPs strtotime function. [source]
It is always possible to set start date, end date and the interval manually by yourself.

Parents

ezcBaseOptions
   |
   --ezcGraphChartElement
      |
      --ezcGraphChartElementAxis
         |
         --ezcGraphChartElementDateAxis

Constants

MAJOR_COUNT = 10 Constant used for calculation of automatic definition of major scaling

Properties

string read/write  $dateFormat
Format of date string Like http://php.net/date
float read/write  $endDate
End date used to display on axis.
float read/write  $interval
Time interval between steps on axis.
float read/write  $startDate
Starting date used to display on axis.

Member Variables

protected int $maxValue = false
Maximum inserted date
protected int $minValue = false
Minimum inserted date
protected array $predefinedIntervals = array(
// Second
1 => 'H:i.s',
// Ten seconds
10 => 'H:i.s',
// Thirty seconds
30 => 'H:i.s',
// Minute
60 => 'H:i',
// Ten minutes
600 => 'H:i',
// Half an hour
1800 => 'H:i',
// Hour
3600 => 'H:i',
// Four hours
14400 => 'H:i',
// Six hours
21600 => 'H:i',
// Half a day
43200 => 'd.m a',
// Day
86400 => 'd.m',
// Week
604800 => 'W',
// Month
2629800 => 'M y',
// Year
31536000 => 'Y',
// Decade
315360000 => 'Y',
)
Nice time intervals to used if there is no user defined interval

Inherited Member Variables

From ezcGraphChartElementAxis:
protected  ezcGraphChartElementAxis::$axisLabelRenderer
From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

public void addData( $values, $value )
Add data for this axis
public void calculateAxisBoundings( )
Calculate axis bounding values on base of the assigned values
protected void calculateInterval( $min, $max )
Calculate nice time interval
protected int calculateLowerNiceDate( $min, $interval )
Calculate lower nice date
public void calculateMaximum( $min, $max )
Calculate end date
public void calculateMinimum( $min, $max )
Calculate start date
protected static int ensureTimestamp( $value )
Ensure proper timestamp
public float getCoordinate( $value, $boundings )
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 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 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 void ezcGraphChartElement::getTitleSize()
public abstract ezcGraphBoundings ezcGraphChartElement::render()
Renders this chart element
public void ezcGraphChartElement::setFromPalette()
Set colors and border fro this element
From ezcBaseOptions :
public void 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.
public mixed ezcBaseOptions::__get()
Property get access.

Methods

addData

void addData( $values, mixed $value )
Add data for this axis

Parameters

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

Redefinition of

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

calculateAxisBoundings

void calculateAxisBoundings( )
Calculate axis bounding values on base of the assigned values

Redefinition of

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

calculateInterval

void calculateInterval( int $min, int $max )
Calculate nice time interval
Use the best fitting time interval defined in class property array predefinedIntervals.

Parameters

Name Type Description
$min int Start time
$max int End time

calculateLowerNiceDate

int calculateLowerNiceDate( int $min, int $interval )
Calculate lower nice date
Calculates a date which is earlier or equal to the given date, and is divisible by the given interval.

Parameters

Name Type Description
$min int Date
$interval int Interval

calculateMaximum

void calculateMaximum( mixed $min, mixed $max )
Calculate end date
Use calculateLowerNiceDate to get a date later or equal date then the maximum date to use it as the end date for the axis depending on the selected interval.

Parameters

Name Type Description
$min mixed Minimum date
$max mixed Maximum date

calculateMinimum

void calculateMinimum( mixed $min, mixed $max )
Calculate start date
Use calculateLowerNiceDate to get a date earlier or equal date then the minimum date to use it as the start date for the axis depending on the selected interval.

Parameters

Name Type Description
$min mixed Minimum date
$max mixed Maximum date

ensureTimestamp

int ensureTimestamp( mixed $value )
Ensure proper timestamp
Takes a mixed value from datasets, like timestamps, or strings describing some time and converts it to a timestamp.

Parameters

Name Type Description
$value mixed  

getCoordinate

float getCoordinate( float $value, ezcGraphBounding $boundings )
Get coordinate for a dedicated value on the chart

Parameters

Name Type Description
$boundings ezcGraphBounding  
$value float Value to determine position for

Redefinition of

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

getLabel

string getLabel( integer $step )
Get label for a dedicated step on the axis

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

integer getMajorStepCount( )
Return count of major steps

Redefinition of

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

getMinorStepCount

integer getMinorStepCount( )
Return count of minor steps

Redefinition of

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

isZeroStep

bool isZeroStep( int $step )
Is zero step
Returns true if the given step is the one on the initial axis position

Parameters

Name Type Description
$step int Number of step

Redefinition of

Method Description
ezcGraphChartElementAxis::isZeroStep() Is zero step

Last updated: Thu, 01 Nov 2007