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

Class: ChartPen

Source Location: /drawing/ChartPen.php

Class Overview

TeeBase
   |
   --ChartPen

ChartPen class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

AxisLinePen
AxisLinePen class
GridPen
GridPen class
TicksPen
TicksPen class

Inherited Variables

Inherited Methods


Class Details

[line 16]
ChartPen class

Description: Common Chart Pen. Pen used to draw lines and borders




Tags:

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


[ Top ]


Class Variables

$color =

[line 18]



Tags:

access:  public

Type:   mixed


[ Top ]

$dashStyle =

[line 19]



Tags:

access:  public

Type:   mixed


[ Top ]

$defaultColor =

[line 25]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultEndCap =

[line 26]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultStyle =

[line 27]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultVisible = false

[line 30]



Tags:

access:  protected

Type:   mixed


[ Top ]

$endCap =

[line 21]



Tags:

access:  public

Type:   mixed


[ Top ]

$usesVisible = false

[line 31]



Tags:

access:  protected

Type:   mixed


[ Top ]

$visible =  true

[line 23]



Tags:

access:  public

Type:   mixed


[ Top ]

$width =

[line 20]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor ChartPen [line 52]

ChartPen ChartPen( $c, [ $startColor = null], [ $startVisible = true], [ $startWidth = 1], [ $startEndCap = -1], [ $startStyle = null])



Tags:

access:  public


Parameters:

   $c  
   $startColor  
   $startVisible  
   $startWidth  
   $startEndCap  
   $startStyle  

[ Top ]

method assign [line 110]

void assign( $p)



Tags:

access:  public


Parameters:

   $p  

[ Top ]

method getColor [line 214]

Color getColor( )

Determines the color used by the pen to draw lines on the Drawing.

It can be any valid color constant like Color.Red, Color.Green, etc.
A special color constant unique to TeeChart is: Color.EMPTY. This is the "default color".

Each TeeChart drawing object has a different default color. For example, the tChart.getFrame() property has a default color of Color.BLACK.




Tags:

access:  public


[ Top ]

method getDashCap [line 289]

DashCap getDashCap( )

Defines segment ending style of dashed lines.
Default value: DashCap.Flat



Tags:

access:  public


[ Top ]

method getDashWidth [line 351]

void getDashWidth( )



Tags:

access:  public


[ Top ]

method getEndCap [line 231]

LineCap getEndCap( )

Style of line endings.



Tags:

access:  public


[ Top ]

method getStroke [line 248]

void getStroke( )



Tags:

access:  public


[ Top ]

method getStyle [line 333]

DashStyle getStyle( )

Determines the style in which the pen draw lines on the Drawing.



Tags:

access:  public


Overridden in child classes as:

GridPen::getStyle()
Determines the style of the axis grid lines.
It sets both vertical and horizontal lines independently.
DefaultValue: DashStyle::$DOT

[ Top ]

method getTransparency [line 189]

int getTransparency( )

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



Tags:

access:  public


[ Top ]

method getVisible [line 170]

boolean getVisible( )

Determines if the pen will draw lines or not.



Tags:

access:  public


[ Top ]

method getWidth [line 307]

int getWidth( )

Determines the width of lines the pen draws.
Default value: 1



Tags:

access:  public


[ Top ]

method internalAssign [line 99]

void internalAssign( $p)



Tags:

access:  public


Parameters:

   $p  

[ Top ]

method invalidate [line 278]

void invalidate( )



Tags:

access:  public


Overrides TeeBase::invalidate() (Use invalidate when the entire canvas needs to be repainted.)

[ Top ]

method reset [line 86]

void reset( )



Tags:

access:  public


[ Top ]

method setColor [line 139]

void setColor( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDashCap [line 293]

void setDashCap( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDashWidth [line 355]

void setDashWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDefaultColor [line 130]

void setDefaultColor( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDefaultStyle [line 151]

void setDefaultStyle( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDefaultVisible [line 156]

void setDefaultVisible( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setEndCap [line 240]

void setEndCap( value $value)

Style of line endings.



Tags:

access:  public


Parameters:

value   $value   LineCap

[ Top ]

method setStyle [line 342]

void setStyle( value $value)

Determines the style in which the pen draw lines on the Drawing.



Tags:

access:  public


Parameters:

value   $value   DashStyle

[ Top ]

method setTransparency [line 199]

void setTransparency( value $value)

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



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setUsesVisible [line 122]

void setUsesVisible( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setVisible [line 179]

void setVisible( value $value)

Determines if the pen will draw lines or not.



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setWidth [line 317]

void setWidth( value $value)

Determines the width of lines the pen draws.
Default value: 1



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method shouldSerializeColor [line 126]

void shouldSerializeColor( )



Tags:

access:  protected


[ Top ]

method shouldSerializeEndCap [line 222]

void shouldSerializeEndCap( )



Tags:

access:  protected


[ Top ]

method shouldSerializeStyle [line 324]

void shouldSerializeStyle( )



Tags:

access:  protected


[ Top ]

method shouldSerializeVisible [line 161]

void shouldSerializeVisible( )



Tags:

access:  protected


[ Top ]

method _assign [line 116]

void _assign( $p, $value)



Tags:

access:  public


Parameters:

   $p  
   $value  

[ Top ]

method _setColor [line 135]

void _setColor( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method __get [line 38]

void __get( $property)



Overridden in child classes as:

GridPen::__get()
TicksPen::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 45]

void __set( $property, $value)



Overridden in child classes as:

GridPen::__set()
TicksPen::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:04:22 +0200 by phpDocumentor 1.4.1