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

Class: Aspect

Source Location: /Aspect.php

Class Overview

TeeBase
   |
   --Aspect

Aspect class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 15]
Aspect class

Description: Chart view characteristics to define Chart 3D appearance




Tags:

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


[ Top ]


Class Variables

$height3D = 0

[line 32]



Tags:

access:  public

Type:   mixed


[ Top ]

$width3D = 0

[line 33]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor Aspect [line 54]

Aspect Aspect( [ $c = null])

The class constructor.



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method assign [line 461]

void assign( Aspect $a)

Copies all properties from a Series component to another.


Only the common properties shared by both source and destination Series are copied.
The following code copies all properties from Series2 into Series1:
tChart1.Series[0].Assign(tChart1.Series[1]);

Some Series types restore values after assigning them. For example, Points Series restores Pointer.Visible to True after being assigned to a Line Series, which has Pointers invisible by default.
Note: Series events are not assigned. Series DataSource and FunctionType are assigned. Assign is used by CloneChartSeries and ChangeSeriesType methods for example.




Tags:

access:  public


Parameters:

Aspect   $a  

[ Top ]

method getApplyZOrder [line 141]

boolean getApplyZOrder( )

Displays multiple Series at different 3D "Z" (depth) positions.


Run-time only.
ApplyZOrder controls if several Series of the same TChart class are displayed in a different Z space for each one.
It's valid only when TChart.Aspect.View3D is true and when there's more than one Series in same chart. When false, all Series are drawn using the full Chart Z space. The Chart output can be confusing if Series overlap.
Default value: true




Tags:

access:  public


[ Top ]

method getChart3DPercent [line 333]

integer getChart3DPercent( )

Percent from 0 to 100 of Z Depth.


Chart3DPercent indicates the size ratio between Chart dimensions and Chart depth when Chart.Aspect.View3D is true. You can specify a percent number from 1 to 100.
Default value: 15




Tags:

access:  public


[ Top ]

method getClipPoints [line 164]

boolean getClipPoints( )

Restricts those Series points displayed outside the Chart axes

rectangle when true.
Chart method defines the TChart or TDBChart component to display on a TQRChart. TQRChart is an "interface" component. It must be associated to a TChart or TDBChart component.
Default value: true




Tags:

access:  public


[ Top ]

method getElevation [line 95]

integer getElevation( )

Determines the angle of 3D elevation in degrees.
Elevation describes front plane rotation by rotation degrees (0 - 360).

Increasing the value positively will bring the top of the Chart towards the viewer and the bottom of the Chart away, moving around an horizontal axis at the central vertical point of the Chart.
Important. Orthogonal should be set to false for Elevation to act on the Chart.
Default value: 345




Tags:

access:  public


[ Top ]

method getHeight3D [line 350]

void getHeight3D( )



Tags:

access:  public


[ Top ]

method getHorizOffset [line 363]

integer getHorizOffset( )

Amount (postive or negative) in pixels of horizontal displacement.


HorizOffset will move the Chart Rectangle horizontally across the Chart Panel. Positive values move the Chart to the right, negative values to the left.
Default value: 0




Tags:

access:  public


[ Top ]

method getOrthoAngle [line 310]

integer getOrthoAngle( )

Angle in degrees, from 0 to 90, when displaying in Orthogonal mode.


OrthoAngle sets the angle of inclination of the Depth axis when the Chart is set to Orthogonal mode, or in other words, when Orthogonal property is set to true.
Default value: 45




Tags:

access:  public


[ Top ]

method getOrthogonal [line 188]

boolean getOrthogonal( )

Displays the Chart in semi-3D mode when true.


Orthogonal displays the Chart in a simulated 3D fashion by drawing the Chart depth at an inclined angle. The bottom of the Chart is always horizontal. When false and the Chart is in 3D, the Chart will display in true 3D mode.
Default value: true




Tags:

access:  public


[ Top ]

method getPerspective [line 288]

integer getPerspective( )




Perspective offers a distance adjustment for the Chart display, giving an appearance of perspective between the nearer and further parts of the Chart.
See the comparison below:
No perspective
Perspective = 50;
Default value: 15




Tags:

access:  public


[ Top ]

method getRotation [line 70]

integer getRotation( )

Determines the angle of 3D rotation in degrees.
Rotation describes front plane rotation by rotation degrees (0 - 360).

Increasing the value positively will bring the right of the Chart towards the viewer and the left of the Chart away, moving around a vertical axis at the central horizontal point of the Chart.
Important. Orthogonal should be set to false for Rotation to act on the Chart.
Default value: 345




Tags:

access:  public


[ Top ]

method getSmoothingMode [line 214]

boolean getSmoothingMode( )

Chooses between speed or display quality for Chart rendering.



for example:-
AntiAlias - Specifies antialiased rendering.
Default - Specifies the default mode.
HighQuality - Specifies high quality, low speed rendering.
HighSpeed - Specifies high speed, low quality rendering.
Invalid - Specifies an invalid mode.
None - Specifies no antialiasing.
Default value: HighSpeed




Tags:

access:  public


[ Top ]

method getTextSmooth [line 241]

boolean getTextSmooth( )

Chooses between speed or display quality for Text rendering.




Tags:

access:  public


[ Top ]

method getTilt [line 116]

integer getTilt( )

Determines the angle of 3D tilt in degrees.


Not supported for 2D or 3D orthogonal Charts
Important. Set TChart.Aspect.Orthogonal = false;
Default value: 0




Tags:

access:  public


[ Top ]

method getVertOffset [line 385]

integer getVertOffset( )

Amount (postive or negative) in pixels of vertical displacement.


Moves the entire Chart on a vertical plane. Not Active for 2D or 3D orthogonal Charts.
Default value: 0




Tags:

access:  public


[ Top ]

method getView3D [line 408]

boolean getView3D( )

Draws each Series with a 3D effect.
You can control the 3D proportion by using Chart.Aspect.Chart3DPercent.

Chart.Walls.Visible depends on View3D.
Default value: true




Tags:

see:  getOrthoAngle
access:  public


[ Top ]

method getWidth3D [line 346]

void getWidth3D( )



Tags:

access:  public


[ Top ]

method getZoom [line 263]

integer getZoom( )

Percent of zoom in 3D mode for the entire Chart.
Increasing the value of Zoom brings the entire Chart towards the viewer.

'In Chart' zoom will still function by mouse dragging within the Chart area and is distinct from whole Chart zooming.
Default value: 100




Tags:

access:  public


[ Top ]

method getZoomText [line 433]

boolean getZoomText( )

Resizes all texts according to Zoom property when true.


When false, Text size will remain constant regardless of the zoom factor obtained with Aspect.Zoom
Default value: true




Tags:

access:  public


[ Top ]

method setApplyZOrder [line 150]

void setApplyZOrder( boolean $value)

Sets the different 3D "Z" depth positions of multiple Series.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setChart3DPercent [line 342]

void setChart3DPercent( integer $value)

Sets the percentage of Z Depth.




Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setClipPoints [line 174]

void setClipPoints( boolean $value)

Restricts those Series points displayed outside the Chart axes rectangle when true.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setElevation [line 104]

void setElevation( integer $value)

Sets the angle of 3D elevation in degrees.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setHorizOffset [line 373]

void setHorizOffset( integer $value)

Sets the amount (postive or negative) in pixels of horizontal displacement.




Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setOrthoAngle [line 320]

void setOrthoAngle( integer $value)

Sets the angle in degrees, from 0 to 90, to display the Chart when in Orthogonal mode.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setOrthogonal [line 197]

void setOrthogonal( boolean $value)

Displays the Chart in semi-3D mode when true.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setPerspective [line 297]

void setPerspective( integer $value)

Sets the percentage of 3D perspective.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setRotation [line 79]

void setRotation( integer $value)

Sets the angle of 3D rotation in degrees.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setSmoothingMode [line 229]

void setSmoothingMode( boolean $value)

Sets the type of rendering used to display the Chart depending on whether speed, display quality or antialiasing is required.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setTextSmooth [line 250]

void setTextSmooth( boolean $value)

Sets the type of rendering used to display Text.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setTilt [line 125]

void setTilt( integer $value)

Sets the angle of 3D tilt in degrees.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setVertOffset [line 395]

void setVertOffset( integer $value)

Sets the amount (postive or negative) in pixels of vertical displacement.




Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setView3D [line 417]

void setView3D( boolean $value)

Draws each Series with a 3D effect when true.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method setZoom [line 272]

void setZoom( integer $value)

Sets the percentage of zoom in 3D mode for the entire Chart.



Tags:

access:  public


Parameters:

integer   $value  

[ Top ]

method setZoomText [line 442]

void setZoomText( boolean $value)

Resizes all texts according to Zoom property when true.



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method __get [line 37]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 44]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:02:45 +0200 by phpDocumentor 1.4.1