TeeChartPHP
[ class tree: TeeChartPHP ] [ index: TeeChartPHP ] [ all elements ]

Class: LegendSymbol

Source Location: /legend/LegendSymbol.php

Class Overview

TeeBase
   |
   --LegendSymbol

<p>Title: LegendSymbol class</p>


Author(s):

Version:

  • 1.0

Copyright:

  • (c) 1995-2010 by Steema Software SL. All Rights Reserved. <info@steema.com>

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 16]
<p>Title: LegendSymbol class</p>

Description: Legend item symbol characteristics

Copyright (c) 2005-2010 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL




Tags:

author:  
version:  1.0
copyright:  (c) 1995-2010 by Steema Software SL. All Rights Reserved. <info@steema.com>


[ Top ]


Class Variables

$continuous = false

[line 23]

Determines if legend symbol should display without separation from other legend item symbols.



Tags:

access:  public

Type:   mixed


[ Top ]

$legend =

[line 33]

Internal field pointing to parent legend class



Tags:

access:  public

Type:   mixed


[ Top ]

$position =

[line 28]

Controls where to display the legend symbol related to symbol item.



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor LegendSymbol [line 60]

LegendSymbol LegendSymbol( $legend)

The class constructor.



Tags:

access:  public


Parameters:

   $legend  

[ Top ]

method calcWidth [line 188]

void calcWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method getContinuous [line 150]

boolean getContinuous( )

Adjoins the different legend color rectangles when true.
The color

rectangles of the different items are drawn attached to each other (no vertical spacing). When false, the color rectangles are drawn as seperate rectangles.
Default value: false




Tags:

access:  public


[ Top ]

method getDefaultPen [line 172]

boolean getDefaultPen( )

Uses series pen properties to draw a border around the coloured box

legend symbol, when true. When false, the Legend will use the legend symbol Pen property.
Default value: true




Tags:

access:  public


[ Top ]

method getPen [line 211]

ChartPen getPen( )

pen used to draw a border around the color box legend symbols.
By default this pen is not used. Instead, the appropiate Series pen is used to draw the symbols borders.
To use this Pen, first set DefaultPen to false.



Tags:

access:  public


[ Top ]

method getPosition [line 99]

LegendSymbolPosition getPosition( )

The position of the Legend color rectangles.


It can have one of the following values:
Left The color rectangles are placed left of the legend items
Right The color rectangles are placed right of the legend items
Default value: Left




Tags:

access:  public


[ Top ]

method getSquared [line 227]

boolean getSquared( )

Resizes the legend symbol to square shaped, when true.


When false, the legend symbol height is determined by the legend font size, and the symbol width is calculated using the Width and WidthUnits properties.
Default value: false




Tags:

access:  public


[ Top ]

method getVisible [line 246]

boolean getVisible( )

Shows or hides Legend symbols.
Default value: true



Tags:

access:  public


[ Top ]

method getWidth [line 82]

int getWidth( )

Defines the width of the color rectangles (symbols).
Default value: 20



Tags:

access:  public


[ Top ]

method getWidthUnits [line 124]

LegendSymbolSize getWidthUnits( )

Defines the Width units for the width of Symbol.



  • Percent is percentage of Legend box width
  • Pixels is the width in standard pixels
Default value: Percent




Tags:

access:  public


[ Top ]

method readResolve [line 71]

void readResolve( )



Tags:

access:  protected


[ Top ]

method setContinuous [line 160]

void setContinuous( value $value)

Adjoins the different legend color rectangles when true.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDefaultPen [line 184]

void setDefaultPen( value $value)

Uses series pen properties to draw a border around the coloured box

legend symbol, when true. When false, the Legend will use the legend symbol Pen property.
Default value: true




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setPosition [line 109]

void setPosition( value $value)

Sets the position of the Legend color rectangles.
Default value: Left



Tags:

access:  public


Parameters:

value   $value   LegendSymbolPosition

[ Top ]

method setSquared [line 236]

void setSquared( value $value)

Resizes the legend symbol to square shaped, when true.




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setVisible [line 256]

void setVisible( value $value)

Shows or hides Legend symbols.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setWidth [line 86]

void setWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setWidthUnits [line 134]

void setWidthUnits( value $value)

Sets the Width units for the width of Symbol.

Default value: Percent



Tags:

access:  public


Parameters:

value   $value   LegendSymbolSize

[ Top ]

method __get [line 43]

void __get( $property)



Overrides TeeBase::__get() (parent method not documented)

Parameters:

   $property  

[ Top ]

method __set [line 50]

void __set( $property, $value)



Overrides TeeBase::__set() (parent method not documented)

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:06:46 +0200 by phpDocumentor 1.4.1