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

Class: ezcGraphChartElementLegend

Class to represent a legend as a chart element [source]

Parents

ezcBaseOptions
   |
   --ezcGraphChartElement
      |
      --ezcGraphChartElementLegend

Properties

float	read/write	$landscapeSize Size of a landscape style legend in percent of the size of the complete chart.
float	read/write	$minimumSymbolSize Scale symbol size up to to percent of complete legends size for very big legends.
float	read/write	$portraitSize Size of a portrait style legend in percent of the size of the complete chart.
int	read/write	$spacing Space between labels elements in pixel.
int	read/write	$symbolSize Standard size of symbols and text in legends.

Member Variables

protected array

$labels Contains data which should be shown in the legend

Inherited Member Variables

From ezcBaseOptions:

protected

ezcBaseOptions::$properties

Method Summary

protected ezcGraphBoundings	calculateBoundings( $boundings ) Calculated boundings needed for the legend.
public void	generateFromDataSet( $dataset ) Generate legend from single dataset with on entry per data element
public void	generateFromDataSets( $datasets ) Generate legend from several datasets with on entry per dataset
public ezcGraphBoundings	render( $renderer, $boundings ) Render a legend
public void	__get( $propertyName )

Inherited Methods

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

calculateBoundings

Parameters

Name	Type	Description
$boundings	ezcGraphBoundings	Avalable boundings

generateFromDataSet

Parameters

Name	Type	Description
$dataset	ezcGraphDataSet

generateFromDataSets

Parameters

Name	Type	Description
$datasets	array

render

Parameters

Name	Type	Description
$renderer	ezcGraphRenderer	Renderer
$boundings	ezcGraphBoundings	Boundings for the axis

Redefinition of

Method	Description
ezcGraphChartElement::render()	Renders this chart element

__get

Parameters

Name	Type	Description
$propertyName

Redefinition of

Method	Description
ezcBaseOptions::__get()	Property get access.