Path

ez components / documentation / api reference / trunk / graph


eZ Components trunk

Graph: ezcGraphOdometerChart

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

Class: ezcGraphOdometerChart

Class for odometer charts. Can only use one dataset which will be dispalyed as a odometer chart. [source]
 1.   $graph new ezcGraphOdometerChart();
 2.   $graph->title 'Custom odometer';
 3.  
 4.   $graph->data['data'new ezcGraphArrayDataSet(
 5.       array87 )
 6.   );
 7.  
 8.   // Set the marker color
 9.   $graph->data['data']->color[0]  '#A0000055';
10.  
11.   // Set colors for the background gradient
12.   $graph->options->startColor     '#2E3436';
13.   $graph->options->endColor       '#EEEEEC';
14.  
15.   // Define a border for the odometer
16.   $graph->options->borderWidth    2;
17.   $graph->options->borderColor    '#BABDB6';
18.  
19.   // Set marker width
20.   $graph->options->markerWidth    5;
21.  
22.   // Set space, which the odometer may consume
23.   $graph->options->odometerHeight .7;
24.  
25.   // Set axis span and label
26.   $graph->axis->min               = 0;
27.   $graph->axis->max               = 100;
28.   $graph->axis->label             'Coverage  ';
29.  
30.   $graph->render400150'custom_odometer_chart.svg' );
Each chart consists of several chart elements which represents logical parts of the chart and can be formatted independently. The odometer chart consists of: All elements can be configured by accessing them as properties of the chart:
 1.   $chart->title->position ezcGraph::BOTTOM;
The chart itself also offers several options to configure the appearance. The extended configure options are available in ezcGraphOdometerChartOptions extending the ezcGraphChartOptions.

Parents

ezcGraphChart
   |
   --ezcGraphOdometerChart

Properties

ezcGraphOdometerChartOptions read/write  $options
Chart options class

Inherited Member Variables

From ezcGraphChart:
protected  ezcGraphChart::$data
protected  ezcGraphChart::$elements
protected  ezcGraphChart::$options
protected  ezcGraphChart::$properties
protected  ezcGraphChart::$renderElement

Method Summary

public int getDefaultDisplayType( )
Returns the default display type of the current chart type.
public void render( $width, $height, [$file = null] )
Render the pie chart
protected void renderData( $renderer, $boundings )
Render the assigned data
protected void renderElements( $width, $height )
Renders the basic elements of this chart type
public void renderToOutput( $width, $height )
Renders this chart to direct output

Inherited Methods

From ezcGraphChart :
protected void ezcGraphChart::addElement()
Add element to chart
public abstract int ezcGraphChart::getDefaultDisplayType()
Returns the default display type of the current chart type.
public mixed ezcGraphChart::getRenderedFile()
Return filename of rendered file, and false if no file was yet rendered.
public abstract void ezcGraphChart::render()
Renders this chart
public abstract void ezcGraphChart::renderToOutput()
Renders this chart to direct output
public void ezcGraphChart::setFromPalette()
Set colors and border fro this element

Methods

getDefaultDisplayType

int getDefaultDisplayType( )
Returns the default display type of the current chart type.

Redefinition of

Method Description
ezcGraphChart::getDefaultDisplayType() Returns the default display type of the current chart type.

render

void render( int $width, int $height, [string $file = null] )
Render the pie chart
Renders the chart into a file or stream. The width and height are needed to specify the dimensions of the resulting image. For direct output use 'php://stdout' as output file.

Parameters

Name Type Description
$width int Image width
$height int Image height
$file string Output file

Redefinition of

Method Description
ezcGraphChart::render() Renders this chart

renderData

void renderData( ezcGraphRenderer $renderer, $boundings )
Render the assigned data
Will renderer all charts data in the remaining boundings after drawing all other chart elements. The data will be rendered depending on the settings in the dataset.

Parameters

Name Type Description
$renderer ezcGraphRenderer Renderer
$boundings ezcGraphBoundings Remaining boundings

renderElements

void renderElements( int $width, int $height )
Renders the basic elements of this chart type

Parameters

Name Type Description
$width int  
$height int  

renderToOutput

void renderToOutput( int $width, int $height )
Renders this chart to direct output
Does the same as ezcGraphChart::render(), but renders directly to output and not into a file.

Parameters

Name Type Description
$width int  
$height int  

Redefinition of

Method Description
ezcGraphChart::renderToOutput() Renders this chart to direct output

Last updated: Mon, 21 Dec 2009