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

Class: SeriesBand

Source Location: /tools/SeriesBand.php

Class Overview

TeeBase
   |
   --Tool
      |
      --ToolSeries
         |
         --SeriesBand

SeriesBand class


Author(s):

Version:

  • 1.0

Copyright:

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

Methods


Inherited Variables

Inherited Methods

Class: ToolSeries

ToolSeries::ToolSeries()
ToolSeries::getHorizAxis()
Returns the associated Top or Bottom Chart Horizontal Axis.
ToolSeries::getSeries()
The Series with which Tools are associated.
Default value: null
ToolSeries::getVertAxis()
Returns the associated Left or Right Chart Vertical Axis.
ToolSeries::setSeries()
Sets the Series with which Tools are associated.
Default value: null
ToolSeries::__get()
ToolSeries::__set()

Class: Tool

Tool::Tool()
Tool::chartEvent()
Tool::getActive()
Enables/Disables the indexed Tool.
Default value: true
Tool::getBitmapEditor()
Returns the URL of the associated icon for a given Tool class.
This icon is used at Tools gallery listbox and Tools Editor dialog.
Tool::getDescription()
Gets descriptive text.
Tool::getFirstLastSeries()
Tool::getSummary()
Gets detailed descriptive text.
Tool::mouseEvent()
Tool::readResolve()
Tool::setActive()
Enables/Disables the indexed Tool.
Default value: true
Tool::setChart()
Tool::toString()
Tool::__get()
Tool::__set()

Class: TeeBase

TeeBase::__construct()
TeeBase::getChart()
Chart associated with this object.
TeeBase::invalidate()
Use invalidate when the entire canvas needs to be repainted.
TeeBase::setBooleanProperty()
TeeBase::setChart()
Chart associated with this object.
TeeBase::setColorProperty()
TeeBase::setDoubleProperty()
TeeBase::setIntegerProperty()
TeeBase::setStringProperty()
TeeBase::_setColorProperty()
TeeBase::__get()
TeeBase::__set()

Class Details

[line 17]
SeriesBand class

Description: Series Band tool. method




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 Methods


constructor SeriesBand [line 26]

SeriesBand SeriesBand( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method chartEvent [line 222]

void chartEvent( $ce)



Tags:

access:  public


Overrides Tool::chartEvent() (parent method not documented)

Parameters:

   $ce  

[ Top ]

method doAfterDrawValues [line 275]

void doAfterDrawValues( $sender)



Tags:

access:  protected


Parameters:

   $sender  

[ Top ]

method doBeforeDrawValues [line 255]

void doBeforeDrawValues( $sender)



Tags:

access:  protected


Parameters:

   $sender  

[ Top ]

method drawBandTool [line 290]

void drawBandTool( )



Tags:

access:  protected


[ Top ]

method getBoundValue [line 42]

double getBoundValue( )

Constant value to be used as one of the limits of band filled areas.
Note: BoundValue property is only used when the <see cref="Series2"/> property is not set (ie: is null).




Tags:

access:  public


[ Top ]

method getBrush [line 116]

ChartBrush getBrush( )

Element Brush characteristics.



Tags:

access:  public


[ Top ]

method getDescription [line 88]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


Overrides Tool::getDescription() (Gets descriptive text.)

[ Top ]

method getDrawBehindSeries [line 65]

boolean getDrawBehindSeries( )

Flag which causes filling to occur before or after the series are displayed.
Default value: true



Tags:

access:  public


[ Top ]

method getGradient [line 182]

Gradient getGradient( )

The gradient colors used to fill the area between the two series.



Tags:

access:  public


[ Top ]

method getPen [line 137]

ChartPen getPen( )

Indicates the kind of pen used to draw Series Band.



Tags:

access:  public


[ Top ]

method getSeries2 [line 107]

Series getSeries2( )

Second series associated to this tool.
SeriesBand tool needs two series to fill the area in between them.




Tags:

access:  public


[ Top ]

method getSummary [line 97]

String getSummary( )

Gets detailed descriptive text.



Tags:

access:  public


Overrides Tool::getSummary() (Gets detailed descriptive text.)

[ Top ]

method getTransparency [line 162]

int getTransparency( )

The amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage.

Default value: 0




Tags:

access:  public


[ Top ]

method setBoundValue [line 54]

void setBoundValue( value $value)

Sets a constant value to be used as one of the limits of band

filled areas.
Note: BoundValue property is only used when the <see cref="Series2"/> property is not set (ie: is null).




Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method setBrush [line 128]

void setBrush( value $value)

Set Brush characteristics.



Tags:

access:  public


Parameters:

value   $value   ChartBrush

[ Top ]

method setDrawBehindSeries [line 76]

void setDrawBehindSeries( value $value)

Sets a flag which causes filling to occur before or after the series are displayed.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setGradient [line 191]

void setGradient( value $value)

Sets the gradient colors used to fill the area between the two series.



Tags:

access:  public


Parameters:

value   $value   Gradient

[ Top ]

method setPen [line 149]

void setPen( value $value)

Determines the kind of pen used to draw Series Band.



Tags:

access:  public


Parameters:

value   $value   ChartPen

[ Top ]

method setSeries [line 236]

void setSeries( $value)



Tags:

access:  public


Overrides ToolSeries::setSeries() (Sets the Series with which Tools are associated.
Default value: null)

Parameters:

   $value  

[ Top ]

method setSeries2 [line 248]

void setSeries2( value $value)

Sets the second series associated to this tool.
SeriesBand tool needs two series to fill the area in between them.




Tags:

access:  public


Parameters:

value   $value   Series

[ Top ]

method setTransparency [line 173]

void setTransparency( value $value)

Sets the amount of semi-glass effect (opacity) to apply when filling the area between the two series as percentage.

Default value: 0




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:07:54 +0200 by phpDocumentor 1.4.1