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

Class: Callout

Source Location: /styles/Callout.php

Class Overview

TeeBase
   |
   --SeriesPointer
      |
      --Callout

Callout class


Author(s):

Version:

  • 1.0

Copyright:

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

Methods


Child classes:

MarksCallout
<p>Title: MarksCallout class</p>
AnnotationCallout
AnnotationCallout class

Inherited Variables

Inherited Methods

Class: SeriesPointer

SeriesPointer::SeriesPointer()
SeriesPointer::assign()
SeriesPointer::calcHorizMargins()
SeriesPointer::calcVerticalMargins()
SeriesPointer::draw()
SeriesPointer::drawLegendShape()
SeriesPointer::getBrush()
Brush used to fill Series Pointers.
SeriesPointer::getColor()
The pointer color.
SeriesPointer::getDark3D()
Fills pointer sides in 3D mode with darker color.
Default value: true
SeriesPointer::getDraw3D()
Draws pointer in 3D mode.
Currently only rectangle points have 3D capability.
Default value: true
SeriesPointer::getEndZ()
For internal use.
SeriesPointer::getGradient()
Configures Gradient filling attributes.
Default value: null
SeriesPointer::getHorizSize()
Horizontal size of pointer in pixels.
SeriesPointer::getInflateMargins()
Expands axes to fit pointers.
SeriesPointer::getMiddleZ()
For internal use.
SeriesPointer::getPen()
Pen used to draw a frame around Series Pointers.
SeriesPointer::getSeries()
SeriesPointer::getStartZ()
For internal use.
SeriesPointer::getStyle()
The Pointer style.
SeriesPointer::getTransparency()
The Percent of semiglass effect.
Default valuie: 0
SeriesPointer::getVertSize()
The Horizontal size of pointer in pixels.
SeriesPointer::getVisible()
Shows or hides the pointer.
SeriesPointer::intDraw()
Internal use. Draw Pointer
SeriesPointer::prepareCanvas()
SeriesPointer::readResolve()
SeriesPointer::setChart()
SeriesPointer::setColor()
Sets the pointer color.
SeriesPointer::setDark3D()
Fills pointer sides in 3D mode with darker color.
Default value: true
SeriesPointer::setDefaultVisible()
SeriesPointer::setDraw3D()
Draws pointer in 3D mode.
Default value: true
SeriesPointer::setHorizSize()
Horizontal size of pointer in pixels.
Default value: 4
SeriesPointer::setInflateMargins()
Expands axes to fit pointers.
Default value: true
SeriesPointer::setStyle()
Sets the Pointer style.
Default value: rectangle
SeriesPointer::setTransparency()
Sets Percent of semiglass effect.
Default valuie: 0
SeriesPointer::setVertSize()
Sets Horizontal size of pointer in pixels.
Default value: 4
SeriesPointer::setVisible()
Shows or hides the pointer.
SeriesPointer::__get()
SeriesPointer::__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]
Callout class

Description: Mark Callout pointer characteristics




Tags:

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


[ Top ]


Class Methods


constructor Callout [line 45]

Callout Callout( [ $s = null])



Tags:

access:  public


Parameters:

   $s  

[ Top ]

method draw [line 56]

void draw( $c, $pFrom, $pTo, $z)



Tags:

access:  public


Overrides SeriesPointer::draw() (parent method not documented)

Parameters:

   $c  
   $pFrom  
   $pTo  
   $z  

[ Top ]

method getArrow [line 122]

ChartPen getArrow( )

Arrow line between a Series Mark and a Series point.
It is also used by Annotation tool to draw a line connecting the annotation and the series point.



Tags:

access:  public


[ Top ]

method getArrowHead [line 152]

ArrowHeadStyle getArrowHead( )

Determines if callout line will display an "arrow" head at the end or not.
See TArrowHeadStyle enumerated values for options.



Tags:

access:  public


[ Top ]

method getArrowHeadSize [line 179]

int getArrowHeadSize( )

The size in pixels to display the arrow head at the end of the callout line.



Tags:

access:  public


[ Top ]

method getDistance [line 205]

int getDistance( )

The length in pixels between a series point and the line connecting the series mark or annotation.



Tags:

access:  public


[ Top ]

method setArrow [line 139]

void setArrow( value $value)

Sets the Arrow line between a Series Mark and a Series point.
It is also used by Annotation tool to draw a line connecting the annotation and the series point.



Tags:

access:  public


Parameters:

value   $value   ChartPen

[ Top ]

method setArrowHead [line 164]

void setArrowHead( value $value)

Determines if callout line will display an "arrow" head at the end or not.




Tags:

access:  public


Parameters:

value   $value   ArrowHeadStyle

[ Top ]

method setArrowHeadSize [line 190]

void setArrowHeadSize( value $value)

Sets the size in pixels of the arrow head at the end of the callout line.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setDistance [line 216]

void setDistance( value $value)

The length in pixels between a series point and the line connecting the series mark or annotation.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method __get [line 31]

void __get( $property)



Overridden in child classes as:

MarksCallout::__get()
AnnotationCallout::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 38]

void __set( $property, $value)



Overridden in child classes as:

MarksCallout::__set()
AnnotationCallout::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:03:39 +0200 by phpDocumentor 1.4.1