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

Class: TeeShape

Source Location: /TeeShape.php

Class Overview

TeeBase
   |
   --TeeShape

Shape class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

TeePanel
TeePanel class
TextShape
TextShape class
Wall
Wall class

Inherited Variables

Inherited Methods


Class Details

[line 15]
Shape class

Description: Base class for Chart Shape elements




Tags:

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


[ Top ]


Class Variables

$bBevel = null

[line 21]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bBorderRound = 0

[line 26]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bBrush = null

[line 24]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bImageBevel = null

[line 23]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bTransparent = false

[line 19]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultVisible = true

[line 17]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pPen = null

[line 20]



Tags:

access:  protected

Type:   mixed


[ Top ]

$shadow = null

[line 22]



Tags:

access:  protected

Type:   mixed


[ Top ]

$shapeBorders = null

[line 27]



Tags:

access:  protected

Type:   mixed


[ Top ]

$shapeBounds = null

[line 25]



Tags:

access:  protected

Type:   mixed


[ Top ]

$visible = true

[line 18]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 47]

TeeShape __construct( [ $c = null])

The class constructor.



Tags:

access:  public


Overridden in child classes as:

TeePanel::__construct()

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

Parameters:

   $c  

[ Top ]

method assign [line 512]

void assign( s $shape)

Assign all properties from a shape to another.



Tags:

access:  public


Overridden in child classes as:

TextShape::assign()
Assign all properties from a TextShape to another.

Parameters:

s   $shape   Shape

[ Top ]

method getBevel [line 190]

TeeBevel getBevel( )

Sets the bevel characteristics of the Shape.



Tags:

access:  public


[ Top ]

method getBevelInner [line 92]

BevelStyle getBevelInner( )

Obsolete.&ndsp;Please use Bevel.<!-- -->Inner.



Tags:

access:  public


[ Top ]

method getBevelOuter [line 134]

BevelStyle getBevelOuter( )

Obsolete.&nbsp;Please use Bevel.<!-- -->Outer



Tags:

access:  public


[ Top ]

method getBevelWidth [line 115]

int getBevelWidth( )

Obsolete.&nbsp;Please use Bevel.<!-- -->Width



Tags:

access:  public


[ Top ]

method getBorderRound [line 241]

int getBorderRound( )

Rounds the Borders of the Chart Shapes.



Tags:

access:  public


[ Top ]

method getBottom [line 469]

int getBottom( )

Shape rectangle bottom co-ordinate.



Tags:

access:  public


[ Top ]

method getBrush [line 222]

ChartBrush getBrush( )

Defines the kind of brush used to fill shape background.



Tags:

access:  public


[ Top ]

method getColor [line 322]

Color getColor( )

Defines the shape Color.



Tags:

access:  public


Overridden in child classes as:

LeftWall::getColor()
The color used to fill the LeftWall background.
Default value: LIGHT_YELLOW

[ Top ]

method getGradient [line 344]

Gradient getGradient( )

Calls the Gradient characteristics for the shape.



Tags:

access:  public


[ Top ]

method getHeight [line 486]

void getHeight( )



Tags:

access:  public


[ Top ]

method getImage [line 265]

Image getImage( )

Rendered Image for Shape background.
Default value: null



Tags:

access:  public


[ Top ]

method getImageBevel [line 179]

ImageBevel getImageBevel( )

Sets the bevel characteristics of the Shape.



Tags:

access:  public


[ Top ]

method getImageMode [line 290]

ImageMode getImageMode( )

ImageMode for rendered Shape background Image.
Default value: ImageMode::$Stretch



Tags:

access:  public


[ Top ]

method getImageTransparent [line 309]

boolean getImageTransparent( )

Sets the shape image to transparent.



Tags:

access:  public


[ Top ]

method getLeft [line 411]

int getLeft( )

Shape rectangle left co-ordinate.



Tags:

access:  public


[ Top ]

method getPen [line 392]

ChartPen getPen( )

Specifies the pen used to draw the shape.



Tags:

access:  public


[ Top ]

method getRight [line 448]

int getRight( )

Shape rectangle right co-ordinate.



Tags:

access:  public


[ Top ]

method getShadow [line 210]

Shadow getShadow( )

Defines the shape's Shadow characteristics.



Tags:

access:  public


[ Top ]

method getShapeBorders [line 61]

shapeBorders getShapeBorders( )

Defines the Shape Borders.



Tags:

access:  public


[ Top ]

method getShapeBounds [line 70]

Rectangle getShapeBounds( )

Defines the boundaries of the Shape.



Tags:

access:  public


[ Top ]

method getTop [line 429]

int getTop( )

Shape rectangle top co-ordinate.



Tags:

access:  public


[ Top ]

method getTransparency [line 592]

int getTransparency( )

The Transparency level from 0 to 100% of shape.


Transparency is a value between 0 and 100 which sets the transparency percentage with respect to foreground versus background.
Default value: 0




Tags:

access:  public


[ Top ]

method getTransparent [line 374]

boolean getTransparent( )

Enables/disables transparency of shape.
See transparency, which sets percentage transparency when Transparent is true.



Tags:

see:  getTransparency
access:  public


[ Top ]

method getVisible [line 353]

boolean getVisible( )

Shows or hides the Shape.



Tags:

access:  public


Overridden in child classes as:

TeePanel::getVisible()
Shows or hides the Panel.
RightWall::getVisible()
Shows/Hides Right Wall.
Default value: false

[ Top ]

method getWidth [line 497]

void getWidth( )



Tags:

access:  public


[ Top ]

method paint [line 535]

void paint( $gd, $rect)



Tags:

access:  public


Overridden in child classes as:

TextShape::paint()
Paints the TextShape object on the Chart Canvas.
Legend::paint()
LeftWall::paint()
Use this method to paint a left wall at rectangle r.
RightWall::paint()
Use this method to paint a right wall at rectangle r.
BackWall::paint()
Use this method to paint a back wall at rectangle r.
BottomWall::paint()
Use this method to paint a bottom wall at rectangle r.

Parameters:

   $gd  
   $rect  

[ Top ]

method setBevel [line 201]

void setBevel( $value)

Internal use - serialization



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setBevelInner [line 106]

void setBevelInner( value $value)

Defines the inner bevel type of the TChart Panel border.


Available types:
None
Lowered
Raised




Tags:

access:  public


Parameters:

value   $value   BevelStyle

[ Top ]

method setBevelOuter [line 148]

void setBevelOuter( value $value)

Defines the outer bevel type of the TChart Panel border.


Available types:
None
Lowered
Raised




Tags:

access:  public


Parameters:

value   $value   BevelStyle

[ Top ]

method setBevelWidth [line 124]

void setBevelWidth( value $value)

Obsolete.&nbsp;Please use Bevel.<!-- -->Width



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setBorderRound [line 250]

void setBorderRound( value $value)

Rounds the Borders of the Chart Shapes.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setBottom [line 478]

void setBottom( value $value)

Shape rectangle bottom co-ordinate.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setBrush [line 232]

void setBrush( $value)

Internal use - serialization



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setChart [line 157]

void setChart( c $c)

Chart associated with this object.



Tags:

access:  public


Overridden in child classes as:

TextShape::setChart()
SeriesMarks::setChart()
Legend::setChart()

Overrides TeeBase::setChart() (Chart associated with this object.)

Parameters:

c   $c   IBaseChart

[ Top ]

method setColor [line 326]

void setColor( $value)



Tags:

access:  public


Overridden in child classes as:

LeftWall::setColor()
Specifies the color used to fill the LeftWall background.
Default value: LIGHT_YELLOW

Parameters:

   $value  

[ Top ]

method setDefaultVisible [line 269]

void setDefaultVisible( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setHeight [line 491]

void setHeight( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setImage [line 280]

void setImage( value $value)

Sets Rendered Image for Shape background.
Default value: null



Tags:

access:  public


Parameters:

value   $value   Image

[ Top ]

method setImageMode [line 300]

void setImageMode( value $value)

Sets the ImageMode for rendered Shape background Image.
Default value: ImageMode.Stretch



Tags:

access:  public


Parameters:

value   $value   ImageMode

[ Top ]

method setImageTransparent [line 313]

void setImageTransparent( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setLeft [line 419]

void setLeft( $value)

Shape rectangle left co-ordinate.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setPen [line 402]

void setPen( $value)

Internal use - serialization



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setRight [line 457]

void setRight( value $value)

Shape rectangle right co-ordinate.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setShapeBounds [line 79]

void setShapeBounds( value $value)

Defines the boundaries of the Shape.



Tags:

access:  public


Parameters:

value   $value   Rectangle

[ Top ]

method setTop [line 438]

void setTop( value $value)

Shape rectangle top co-ordinate.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setTransparency [line 602]

void setTransparency( value $value)

Sets Transparency level from 0 to 100% of shape.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setTransparent [line 383]

void setTransparent( value $value)

Enables/disables transparency of shape.




Tags:

access:  public


Overridden in child classes as:

TeePanel::setTransparent()

Parameters:

value   $value   boolean

[ Top ]

method setVisible [line 362]

void setVisible( value $value)

Shows or hides the Shape.



Tags:

access:  public


Overridden in child classes as:

TeePanel::setVisible()
Shows or hides the Panel.
RightWall::setVisible()
Shows/Hides Right Wall.
Default value: false

Parameters:

value   $value   boolean

[ Top ]

method setWidth [line 502]

void setWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method _setColor [line 335]

void _setColor( value $value)

Defines the shape Color.



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method __get [line 30]


method __set [line 37]

void __set( $property, $value)



Overridden in child classes as:

TeePanel::__set()
TextShape::__set()
AxisLabelItem::__set()
AxisLabels::__set()
AxisTitle::__set()
LegendTitle::__set()
SeriesMarks::__set()
TextShapePosition::__set()
Legend::__set()
Title::__set()
Footer::__set()
Wall::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:08:41 +0200 by phpDocumentor 1.4.1