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

Class: ColorLine

Source Location: /tools/ColorLine.php

Class Overview

TeeBase
   |
   --Tool
      |
      --ToolAxis
         |
         --ColorLine

ColorLine 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: ToolAxis

ToolAxis::ToolAxis()
ToolAxis::getAxis()
The axis to which a Tool will belong.
Default value: null
ToolAxis::getPen()
Element Pen characteristics.
ToolAxis::setAxis()
Sets the axis to which a Tool will belong.
Default value: null
ToolAxis::__get()
ToolAxis::__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 16]
ColorLine class

Description: Color Line tool. To draw custom lines at a axis value




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 ColorLine [line 43]

ColorLine ColorLine( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method addDragListener [line 49]

void addDragListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method calcValue [line 85]

void calcValue( )



Tags:

access:  protected


[ Top ]

method chartEvent [line 174]

void chartEvent( $e)



Tags:

access:  public


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

Parameters:

   $e  

[ Top ]

method doDragLine [line 361]

void doDragLine( )



Tags:

access:  protected


[ Top ]

method doEndDragLine [line 356]

void doEndDragLine( )



Tags:

access:  protected


[ Top ]

method getAllowDrag [line 387]

boolean getAllowDrag( )

Allows mousedrag of Line when true.
Default value: true



Tags:

access:  public


[ Top ]

method getDescription [line 341]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


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

[ Top ]

method getDragRepaint [line 410]

boolean getDragRepaint( )

Repaints the Chart while moving the ColorLine when true.
Set to true to repaint the Chart while moving the ColorLine.
Default value: false



Tags:

access:  public


[ Top ]

method getDraw3D [line 432]

boolean getDraw3D( )

Draws ColorLine in 3D when true.
Default value: true



Tags:

access:  public


[ Top ]

method getDrawBehind [line 454]

boolean getDrawBehind( )

Draws the ColorLine behind the series values.
Default value: false



Tags:

access:  public


[ Top ]

method getNoLimitDrag [line 476]

boolean getNoLimitDrag( )

Allows drag of ColorLine outside of the Chart rectangle.
Default value: false



Tags:

access:  public


[ Top ]

method getStyle [line 65]

ColorLineStyle getStyle( )

Default value: ColorLineStyle.CUSTOM



Tags:

access:  public


[ Top ]

method getSummary [line 351]

String getSummary( )

Gets detailed descriptive text.



Tags:

access:  public


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

[ Top ]

method getValue [line 498]

double getValue( )

Determines Axis position where the ColorLine has to be drawn.
Default value: 0



Tags:

access:  public


[ Top ]

method mouseEvent [line 189]

void mouseEvent( $e, $c)



Tags:

access:  public


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

Parameters:

   $e  
   $c  

[ Top ]

method removeDragListener [line 54]

void removeDragListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method setAllowDrag [line 398]

void setAllowDrag( value $value)

Allows mousedrag of Line when true.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDragRepaint [line 421]

void setDragRepaint( value $value)

Set to true to repaint the Chart while moving the ColorLine.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDraw3D [line 443]

void setDraw3D( value $value)

Draws ColorLine in 3D when true.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDrawBehind [line 465]

void setDrawBehind( value $value)

Draws the ColorLine behind the series values.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setNoLimitDrag [line 487]

void setNoLimitDrag( value $value)

Allows drag of ColorLine outside of the Chart rectangle.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStyle [line 76]

void setStyle( value $value)

Default value: ColorLine.CUSTOM



Tags:

access:  public


Parameters:

value   $value   ColorLineStyle

[ Top ]

method setValue [line 509]

void setValue( value $value)

Sets the Axis position where the ColorLine has to be drawn.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   double

[ Top ]

method __get [line 29]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 36]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


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