com.steema.teechart
Class Aspect

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.Aspect

All Implemented Interfaces:

java.io.Serializable

public final class Aspect
extends TeeBase

Title: Aspect class

Description: Chart view characteristics to define Chart 3D appearance

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

Company: Steema Software SL

See Also:

Serialized Form

Field Summary

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Aspect()

Aspect(IBaseChart c)

Method Summary

void	assign(Aspect a) Copies all properties from a Series component to another.
boolean	getApplyZOrder() Displays multiple Series at different 3D "Z" (depth) positions.
int	getChart3DPercent() Percent from 0 to 100 of Z Depth.
boolean	getClipPoints() Restricts those Series points displayed outside the Chart axes rectangle when true.
int	getElevation() Determines the angle of 3D elevation in degrees.
int	getHeight3D()
int	getHorizOffset() Amount (postive or negative) in pixels of horizontal displacement.
int	getOrthoAngle() Angle in degrees, from 0 to 90, when displaying in Orthogonal mode.
boolean	getOrthogonal() Displays the Chart in semi-3D mode when true.
int	getPerspective() Perspective offers a distance adjustment for the Chart display, giving an appearance of perspective between the nearer and further parts of the Chart.
int	getRotation() Determines the angle of 3D rotation in degrees.
boolean	getSmoothingMode() Chooses between speed or display quality for Chart rendering.
boolean	getTextSmooth() Chooses between speed or display quality for Text rendering.
int	getTilt() Determines the angle of 3D tilt in degrees.
int	getVertOffset() Amount (postive or negative) in pixels of vertical displacement.
boolean	getView3D() Draws each Series with a 3D effect.
int	getWidth3D()
int	getZoom() Percent of zoom in 3D mode for the entire Chart.
boolean	getZoomText() Resizes all texts according to Zoom property when true.
void	setApplyZOrder(boolean value) Sets the different 3D "Z" depth positions of multiple Series.
void	setChart3DPercent(int value) Sets the percentage of Z Depth.
void	setClipPoints(boolean value) Restricts those Series points displayed outside the Chart axes rectangle when true.
void	setElevation(int value) Sets the angle of 3D elevation in degrees.
void	setHorizOffset(int value) Sets the amount (postive or negative) in pixels of horizontal displacement.
void	setOrthoAngle(int value) Sets the angle in degrees, from 0 to 90, to display the Chart when in Orthogonal mode.
void	setOrthogonal(boolean value) Displays the Chart in semi-3D mode when true.
void	setPerspective(int value) Sets the percentage of 3D perspective.
void	setRotation(int value) Sets the angle of 3D rotation in degrees.
void	setSmoothingMode(boolean value) Sets the type of rendering used to display the Chart depending on whether speed, display quality or antialiasing is required.
void	setTextSmooth(boolean value) Sets the type of rendering used to display Text.
void	setTilt(int value) Sets the angle of 3D tilt in degrees.
void	setVertOffset(int value) Sets the amount (postive or negative) in pixels of vertical displacement.
void	setView3D(boolean value) Draws each Series with a 3D effect when true.
void	setZoom(int value) Sets the percentage of zoom in 3D mode for the entire Chart.
void	setZoomText(boolean value) Resizes all texts according to Zoom property when true.

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Aspect

public Aspect()

Aspect

public Aspect(IBaseChart c)

Method Detail

getRotation

public int 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

Returns:

int

setRotation

public void setRotation(int value)

Sets the angle of 3D rotation in degrees.

Parameters:

value - int

getElevation

public int 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

Returns:

int

setElevation

public void setElevation(int value)

Sets the angle of 3D elevation in degrees.

Parameters:

value - int

getTilt

public int 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

Returns:

int

setTilt

public void setTilt(int value)

Sets the angle of 3D tilt in degrees.

Parameters:

value - int

getApplyZOrder

public 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

Returns:

boolean

setApplyZOrder

public void setApplyZOrder(boolean value)

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

Parameters:

value - boolean

getClipPoints

public 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

Returns:

boolean

setClipPoints

public void setClipPoints(boolean value)

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

Parameters:

value - boolean

getOrthogonal

public 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

Returns:

boolean

setOrthogonal

public void setOrthogonal(boolean value)

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

Parameters:

value - boolean

getSmoothingMode

public 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

Returns:

boolean

setSmoothingMode

public void setSmoothingMode(boolean value)

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

Parameters:

value - boolean

getTextSmooth

public boolean getTextSmooth()

Chooses between speed or display quality for Text rendering.

Returns:

boolean

setTextSmooth

public void setTextSmooth(boolean value)

Sets the type of rendering used to display Text.

Parameters:

value - boolean

getZoom

public int 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

Returns:

int

setZoom

public void setZoom(int value)

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

Parameters:

value - int

getPerspective

public int 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

Returns:

int

setPerspective

public void setPerspective(int value)

Sets the percentage of 3D perspective.

Parameters:

value - int

getOrthoAngle

public int 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

Returns:

int

setOrthoAngle

public void setOrthoAngle(int value)

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

Parameters:

value - int

getChart3DPercent

public int 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

Returns:

int

setChart3DPercent

public void setChart3DPercent(int value)

Sets the percentage of Z Depth.

Parameters:

value - int

getWidth3D

public int getWidth3D()

getHeight3D

public int getHeight3D()

getHorizOffset

public int 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

Returns:

int

setHorizOffset

public void setHorizOffset(int value)

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

Parameters:

value - int

getVertOffset

public int 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

Returns:

int

setVertOffset

public void setVertOffset(int value)

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

Parameters:

value - int

getView3D

public 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

Returns:

boolean

See Also:

getOrthoAngle()

setView3D

public void setView3D(boolean value)

Draws each Series with a 3D effect when true.

Parameters:

value - boolean

getZoomText

public 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

Returns:

boolean

setZoomText

public void setZoomText(boolean value)

Resizes all texts according to Zoom property when true.

Parameters:

value - boolean

assign

public 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.

Parameters:

a - Aspect