Path

ez components / documentation / api reference / 2008.1beta1 / graph

eZ Components 2008.1beta1

Graph: ezcGraphChartElement

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

Class: ezcGraphChartElement

Class for basic chart elements [source]

Parents

ezcBaseOptions
   |
   --ezcGraphChartElement

Descendents

Child Class Description
ezcGraphChartElementBackground Chart element representing the background. In addition to the standard background and border for chart elements it can draw an image on the chart background, and optionally repeat it. The position will be used for the repetition offset.
ezcGraphChartElementText Chart element to display texts in a chart
ezcGraphChartElementAxis Basic axis class
ezcGraphChartElementLegend Class to represent a legend as a chart element

Properties

ezcGraphColor read/write  $background
Background color of chart element.
ezcGraphColor read/write  $border
Border color of chart element.
int read/write  $borderWidth
Border width.
ezcGraphBoundings read  $boundings
Boundings of this elements.
ezcGraphFontOptions read/write  $font
Font used for this element.
bool read  $fontCloned
Indicates if font configuration was already cloned for this specific element.
float read/write  $landscapeTitleSize
Percentage of boundings which are used for the title with position top or bottom.
int read/write  $margin
Distance between outer boundings and border of an element.
int read/write  $maxTitleHeight
Maximum size of the title.
int read/write  $padding
Distance between border and content of element.
float read/write  $portraitTitleSize
Percentage of boundings which are used for the title with position left, right or center.
int read/write  $position
Integer defining the elements position in the chart.
string read/write  $title
Title of chart element.

Inherited Member Variables

From ezcBaseOptions:
protected  ezcBaseOptions::$properties

Method Summary

protected ezcGraphBoundings getTitleSize( $boundings, [$direction = ezcGraph::HORIZONTAL] )
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 render( $renderer, $boundings )
Renders this chart element
public void setFromPalette( $palette )
Set colors and border fro this element

Inherited Methods

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

getTitleSize

ezcGraphBoundings getTitleSize( $boundings, [int $direction = ezcGraph::HORIZONTAL] )
Returns calculated boundings based on available percentual space of given bounding box specified in the elements options and direction of the box.

Parameters

Name Type Description
$boundings ezcGraphBoundings  
$direction int  

render

ezcGraphBoundings render( ezcGraphRenderer $renderer, $boundings )
Renders this chart element
This method receives and returns a part of the canvas where it can be rendered on.

Parameters

Name Type Description
$renderer ezcGraphRenderer  
$boundings ezcGraphBoundings  

Redefined in descendants as

Method Description
ezcGraphChartElementBackground::render() Render the background
ezcGraphChartElementText::render() Render the text
ezcGraphChartElementAxis::render() Render the axis
ezcGraphChartElementLegend::render() Render a legend

setFromPalette

void setFromPalette( ezcGraphPalette $palette )
Set colors and border fro this element

Parameters

Name Type Description
$palette ezcGraphPalette Palette

Redefined in descendants as

Method Description
ezcGraphChartElementBackground::setFromPalette() Set colors and border for this element
ezcGraphChartElementAxis::setFromPalette() Set colors and border fro this element

Last updated: Tue, 27 May 2008