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

Class: SeriesPointer

Source Location: /styles/SeriesPointer.php

Class Overview

TeeBase
   |
   --SeriesPointer

<p>Title: SeriesPointer class</p>


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Callout
Callout class

Inherited Variables

Inherited Methods


Class Details

[line 18]
<p>Title: SeriesPointer class</p>

Description: Some Series have a Pointer method which returns a SeriesPointer class. Pointers are shape figures drawn on each Y point coordinate.

Copyright (c) 2005-2008 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL




Tags:

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


[ Top ]


Class Variables

$allowChangeSize = true

[line 32]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bVisible =  true

[line 30]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultVisible = true

[line 31]



Tags:

access:  protected

Type:   mixed


[ Top ]

$draw3D =  true

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor SeriesPointer [line 53]

SeriesPointer SeriesPointer( $c, $s)



Tags:

access:  public


Parameters:

   $c  
   $s  

[ Top ]

method assign [line 62]

void assign( $source)



Tags:

access:  public


Parameters:

   $source  

[ Top ]

method calcHorizMargins [line 645]

void calcHorizMargins( $margins)



Tags:

access:  public


Parameters:

   $margins  

[ Top ]

method calcVerticalMargins [line 652]

void calcVerticalMargins( $margins)



Tags:

access:  public


Parameters:

   $margins  

[ Top ]

method draw [line 560]

void draw( $px, $py, $colorValue, [ $aStyle = 0])



Tags:

access:  public


Overridden in child classes as:

Callout::draw()

Parameters:

   $px  
   $py  
   $colorValue  
   $aStyle  

[ Top ]

method drawLegendShape [line 624]

void drawLegendShape( $g, $color, $rect, $drawPen)



Tags:

access:  public


Parameters:

   $g  
   $color  
   $rect  
   $drawPen  

[ Top ]

method getBrush [line 608]

ChartBrush getBrush( )

Brush used to fill Series Pointers.



Tags:

access:  public


[ Top ]

method getColor [line 390]

Color getColor( )

The pointer color.



Tags:

access:  public


[ Top ]

method getDark3D [line 92]

boolean getDark3D( )

Fills pointer sides in 3D mode with darker color.
Default value: true



Tags:

access:  public


[ Top ]

method getDraw3D [line 113]

boolean getDraw3D( )

Draws pointer in 3D mode.
Currently only rectangle points have 3D capability.
Default value: true



Tags:

access:  public


[ Top ]

method getEndZ [line 377]

int getEndZ( )

For internal use.



Tags:

access:  public


[ Top ]

method getGradient [line 296]

Gradient getGradient( )

Configures Gradient filling attributes.
Default value: null

Example:


   bubbleSeries.getPointer().getGradient().setVisible(true);
 




Tags:

access:  public


[ Top ]

method getHorizSize [line 165]

int getHorizSize( )

Horizontal size of pointer in pixels.


Series that derive from Points series usually override the HorizSize and VertSize methods.
For example, Bubble series uses the Radius method to determine the correct HorizSize and VertSize, so these methods have no effect in that Series.
Default value: 4




Tags:

access:  public


[ Top ]

method getInflateMargins [line 187]

boolean getInflateMargins( )

Expands axes to fit pointers.


When false, Chart Axis scales will be preserved and points close to the Axis limits will be partially displayed.
Default value: true




Tags:

access:  public


[ Top ]

method getMiddleZ [line 364]

int getMiddleZ( )

For internal use.



Tags:

access:  public


[ Top ]

method getPen [line 595]

ChartPen getPen( )

Pen used to draw a frame around Series Pointers.



Tags:

access:  public


[ Top ]

method getSeries [line 231]

void getSeries( )



Tags:

access:  public


[ Top ]

method getStartZ [line 351]

int getStartZ( )

For internal use.



Tags:

access:  public


[ Top ]

method getStyle [line 212]

PointerStyle getStyle( )

The Pointer style.


It defines the shape used to display the Series Points.
The default Rectangle style can be optionally in 3D mode by setting Pointer.Draw3D to true.
Series Pointer.Visible should be true.
Default value: rectangle




Tags:

access:  public


[ Top ]

method getTransparency [line 266]

int getTransparency( )

The Percent of semiglass effect.
Default valuie: 0



Tags:

access:  public


[ Top ]

method getVertSize [line 246]

int getVertSize( )

The Horizontal size of pointer in pixels.


Series that derive from PointSeries usually override the HorizontalSize and VerticalSize methods.
For example, Bubble series uses the Radius property to determine the correct HorizSize and VertSize, so these methods have no effect in that Series.
Default value: 4




Tags:

access:  public


[ Top ]

method getVisible [line 141]

boolean getVisible( )

Shows or hides the pointer.


When using a Points series (or any Series class derived from Points series), setting Visible to false will not display anything.
Pointers can be useful with Line series or Area series.
When points are Visible, extra margins are applied to the four chart axes (Left, Right, Top and Bottom). This is to make points just at axis limits to be shown.
You can deactivate these extra margins by setting IPointer.InflateMargins to false.

Points are filled using IPointer.Brush.




Tags:

access:  public


[ Top ]

method intDraw [line 426]

void intDraw( g $g, is3D $is3D, px $px, py $py, tmpHoriz $tmpHoriz, tmpVert $tmpVert, colorValue $colorValue, [aStyle $aStyle = 0])

Internal use. Draw Pointer



Tags:

access:  public


Parameters:

g   $g   IGraphics3D
is3D   $is3D   boolean
px   $px   int
py   $py   int
tmpHoriz   $tmpHoriz   int
tmpVert   $tmpVert   int
colorValue   $colorValue   Color
aStyle   $aStyle   PointerStyle

[ Top ]

method prepareCanvas [line 567]

void prepareCanvas( $g, $colorValue)



Tags:

access:  public


Parameters:

   $g  
   $colorValue  

[ Top ]

method readResolve [line 81]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

MarksCallout::readResolve()

[ Top ]

method setChart [line 403]

void setChart( $c)



Tags:

access:  public


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

Parameters:

   $c  

[ Top ]

method setColor [line 399]

void setColor( value $value)

Sets the pointer color.



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setDark3D [line 102]

void setDark3D( value $value)

Fills pointer sides in 3D mode with darker color.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setDefaultVisible [line 659]

void setDefaultVisible( $value)



Parameters:

   $value  

[ Top ]

method setDraw3D [line 123]

void setDraw3D( value $value)

Draws pointer in 3D mode.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setHorizSize [line 175]

void setHorizSize( value $value)

Horizontal size of pointer in pixels.
Default value: 4



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setInflateMargins [line 197]

void setInflateMargins( value $value)

Expands axes to fit pointers.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStyle [line 223]

void setStyle( value $value)

Sets the Pointer style.
Default value: rectangle



Tags:

access:  public


Parameters:

value   $value   PointerStyle

[ Top ]

method setTransparency [line 281]

void setTransparency( value $value)

Sets Percent of semiglass effect.
Default valuie: 0

Example:


 bubbleSeries.getPointer().setTransparency(50); // -- 50 %
 




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setVertSize [line 256]

void setVertSize( value $value)

Sets Horizontal size of pointer in pixels.
Default value: 4



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setVisible [line 150]

void setVisible( value $value)

Shows or hides the pointer.




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method __get [line 38]

void __get( $property)



Overridden in child classes as:

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

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

Parameters:

   $property  

[ Top ]

method __set [line 45]

void __set( $property, $value)



Overridden in child classes as:

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

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

Parameters:

   $property  
   $value  

[ Top ]


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