com.steema.teechart
Class Chart

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

All Implemented Interfaces:

IBaseChart, java.io.Serializable, java.lang.Cloneable

public class Chart
extends TeeBase
implements IBaseChart, java.io.Serializable, java.lang.Cloneable

Title: Chart class

Description: Chart contents.

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

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

class

Chart.ChartToolTip Title: Tooltips class Description: Tooltips Copyright (c) 2005-2006 by Steema Software SL.

Field Summary

protected Aspect	aspect
protected Axes	axes
AxisSavedScales	bottom
protected Rectangle	chartBounds
protected Rectangle	chartRect
boolean	clipWhenMetafiling
boolean	clipWhenPrinting
protected IGraphics3D	graphics3D
protected boolean	iClicked
AxisSavedScales	left
protected Legend	legend
protected ChartPen	legendPen
protected int	maxZOrder
protected Page	page
protected IChart	parent
protected boolean	printing
protected boolean	restoredAxisScales
AxisSavedScales	right
protected SeriesCollection	series
protected int	seriesHeight3D
protected int	seriesWidth3D
AxisSavedScales	top
protected Zoom	zoom

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Chart()

Chart(IChart parent)

Chart(IChart parent, java.awt.Cursor cursor)

Method Summary

Series	activeSeriesLegend(int itemIndex) Returns the Active series (visible) that corresponds to the ItemIndex position in the Legend.
int	addSeries(Series value)
TeeEvent	broadcastEvent(Series s, SeriesEventStyle e)
void	broadcastEvent(TeeEvent event)
protected void	broadcastMouseEvent(java.awt.event.MouseEvent e)
protected java.awt.Cursor	broadcastMouseEvent(java.awt.event.MouseEvent e, java.awt.Cursor c)
protected void	broadcastToolEvent(ChartDrawEvent ce)
boolean	canClip() Returns the number of active (visible) series.
boolean	canDrawPanelBack()
static void	changeAllSeriesType(Chart chart, java.lang.Class newClass)
static Series	changeSeriesType(Series series, java.lang.Class newClass)
protected int	chartRectHeight()
protected int	chartRectWidth()
protected void	checkZoomPanning(java.awt.event.MouseEvent e)
java.lang.Object	clone()
int	countActiveSeries() Returns the number of active (visible) series.
void	doBaseInvalidate()
void	doChangedBrush(ChartBrush value)
void	doChangedFont(ChartFont value)
Rectangle	doDrawLegend(IGraphics3D g, Rectangle tmp)
java.awt.Cursor	doMouseMove(int x, int y, java.awt.Cursor c)
void	doZoom(double topx, double topy, double bottomx, double bottomy, double leftx, double lefty, double rightx, double righty)
void	doZoom(java.awt.geom.Point2D.Double top, java.awt.geom.Point2D.Double bot, java.awt.geom.Point2D.Double lef, java.awt.geom.Point2D.Double rig)
java.lang.String	formattedLegend(int seriesOrValueIndex) Returns the text string corresponding to a Legend position.
java.lang.String	formattedValueLegend(Series aSeries, int valueIndex) Returns the String to display at Legend for a given series and point index.
Color	freeSeriesColor(boolean checkBackground) Returns a color from the default color palette not used by any Series.
Aspect	getAspect() 3D view parameters.
boolean	getAutoRepaint() Returns if the Chart should automatically repaint itself when a property has been changed.
Axes	getAxes() Accesses the five axes, Top, Left, Right, Bottom and z depthas well as custom axis objects.
Series	getAxisSeries(Axis axis) Returns the first Series that depends on the specified Axis.
int	getBottom()
Rectangle	getChartBounds() (Read only) Used to get the four sides of the Chart (Left, Top, Right and Bottom)
Rectangle	getChartRect() Returns the rectangle that contains the four main Chart axes.
protected int	getChartRectBottom()
Exports	getExport() Accesses Chart export attributes.
Series	getFirstActiveSeries() Returns first active (visible) series.
Footer	getFooter() Defines the Text and formatting attributes to be drawn at the bottom of the Chart.
IGraphics3D	getGraphics3D() Accesses TeeChart Draw attributes.
Header	getHeader() Defines the Text and formatting attributes to be drawn at the top of the Chart.
int	getHeight() The Chart Height in pixels.
Imports	getImport() Accesses Chart import attributes.
Series	getItem(int index) Default indexer.
int	getLeft()
Legend	getLegend() Determines the Legend characteristics.
ChartPen	getLegendPen()
TeeEventListeners	getListeners() Returns array list of objects that implement the TeeEventListener interface.
int	getMaxValuesCount()
double	getMaxXValue(Axis axis) Returns the Maximum Value of the Series X Values List.
double	getMaxYValue(Axis axis) Returns the highest of all the current Series Y point values.
int	getMaxZOrder()
double	getMinXValue(Axis axis) Returns the Minimum Value of the Series X Values List.
double	getMinYValue(Axis axis) Returns the Minimum Value of the Series Y Values List.
int	getNumPages()
Page	getPage() Accesses multiple page characteristics of the Chart.
Panel	getPanel() Accesses all visible Background attributes..
Scroll	getPanning() Sets the scrolling direction or denies scrolling.
IChart	getParent()
Printer	getPrinter() Printing related attributes.
boolean	getPrinting() Determines when Chart is being printed.
int	getRight()
SeriesCollection	getSeries() Collection of Series contained in this Chart.
Series	getSeries(int seriesIndex)
int	getSeriesCount() Returns the number of Series associated to this Chart.
int	getSeriesHeight3D()
int	getSeriesIndexOf(Series value)
java.lang.String	getSeriesTitleLegend(int seriesIndex, boolean onlyActive) Returns the Series.Title string.
int	getSeriesWidth3D()
Footer	getSubFooter() Defines the Text and formatting attributes to be drawn at the bottom of the Chart, just above the Footer text.
Header	getSubHeader() Defines the Text and formatting attributes to be drawn at the top of the Chart, just below the Header text.
Header	getSubTitle() Obsolete.
Header	getTitle() Obsolete.
Tool	getTool(int index) Gets the index'th tool in getTools() collection
ToolsCollection	getTools() Collection of Tool components contained in this Chart.
ToolTip	getToolTip() Displays a text box at the cursor.
int	getTop()
Walls	getWalls() Accesses left, bottom and back wall characteristics of the Chart.
int	getWidth() The Chart width in pixels.
Zoom	getZoom() Accesses the Zoom characteristics of the Chart.
java.awt.Image	image(int width, int height)
protected void	internalDraw(IGraphics3D g) Main drawing procedure.
double	internalMinMax(Axis aAxis, boolean isMin, boolean isX)
boolean	isAxisCustom(Axis axis)
boolean	isAxisVisible(Axis a)
boolean	isFreeSeriesColor(Color color, boolean checkBackground) Returns whether the AColor parameter is used by any Series or not.
boolean	isValidDataSource(Series s, java.lang.Object source)
int	maxMarkWidth() Returns the Maximum width of the Active Series Marks.
int	maxTextWidth() Returns the Maximum width in pixels of all Series Labels, whether active or not.
java.awt.Cursor	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	moveSeriesTo(Series value, int newIndex)
MultiLine	multiLineTextWidth(java.lang.String s)
void	paint()
void	paint(IGraphics3D g) Paints the Chart on the Drawing Canvas g.
void	paint(IGraphics3D g, int width, int height)
void	paint(IGraphics3D g, Rectangle rect) Paints the Chart in your preferred Canvas and region.
protected java.lang.Object	readResolve()
Rectangle	recalcWidthHeight(Rectangle r)
protected void	removeAllComponents()
protected void	removeListener(ITeeEventListener sender)
void	removeSeries(Series value) Removes a Series from the Chart series list, without disposing it.
void	restoreAxisScales()
java.util.Iterator	series()
Series	seriesLegend(int itemIndex, boolean onlyActive) Returns the series that corresponds to the Legend "ItemIndex" position, when the Legend style is "Series".
void	setAspect(Aspect value)
void	setAutoRepaint(boolean value) Sets if this Chart should automatically repaint after a property change.
void	setAxes(Axes value)
void	setBrushCanvas(Color aColor, ChartBrush aBrush, Color aBackColor)
void	setCancelMouse(boolean value)
void	setChartBounds(Rectangle value) Sets the four sides of the Chart (Left, Top, Right and Bottom)
void	setChartRect(Rectangle value) Sets the rectangle to contain the four main Chart axes.
void	setExport(Exports value)
void	setFooter(Footer value)
void	setGraphics3D(IGraphics3D value)
void	setHeader(Header value)
void	setHeight(int value) Sets the Chart Height in pixels.
void	setImport(Imports value)
void	setItem(int index, Series value) Default indexer.
void	setLegend(Legend value)
void	setLegendPen(ChartPen value)
void	setMaxZOrder(int value)
void	setPage(Page value)
void	setPanel(Panel value)
void	setPanning(Scroll panning)
void	setParent(IChart value) Internal use.
void	setPrinter(Printer value)
void	setPrinting(boolean value) Determines when Chart is being printed.
void	setSeries(SeriesCollection value)
void	setSubFooter(Footer value)
void	setSubHeader(Header value)
void	setTools(ToolsCollection value)
void	setWalls(Walls value)
void	setWidth(int value) Sets the Chart width in pixels.
void	setZoom(Zoom zoom)
java.util.Iterator	tools()
void	undoZoom() Obsolete.

Methods inherited from class com.steema.teechart.TeeBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.steema.teechart.IBaseChart

invalidate

Field Detail

aspect

protected Aspect aspect

iClicked

protected transient boolean iClicked

axes

protected Axes axes

graphics3D

protected transient IGraphics3D graphics3D

legend

protected Legend legend

series

protected SeriesCollection series

parent

protected transient IChart parent

page

protected Page page

restoredAxisScales

protected transient boolean restoredAxisScales

legendPen

protected transient ChartPen legendPen

printing

protected transient boolean printing

clipWhenMetafiling

public boolean clipWhenMetafiling

clipWhenPrinting

public boolean clipWhenPrinting

seriesWidth3D

protected transient int seriesWidth3D

seriesHeight3D

protected transient int seriesHeight3D

maxZOrder

protected transient int maxZOrder

chartBounds

protected Rectangle chartBounds

chartRect

protected Rectangle chartRect

zoom

protected Zoom zoom

left

public AxisSavedScales left

top

public AxisSavedScales top

right

public AxisSavedScales right

bottom

public AxisSavedScales bottom

Constructor Detail

Chart

public Chart()

Chart

public Chart(IChart parent)

Chart

public Chart(IChart parent,
             java.awt.Cursor cursor)

Method Detail

readResolve

protected java.lang.Object readResolve()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

image

public java.awt.Image image(int width,
                            int height)

Specified by:

image in interface IBaseChart

getChartBounds

public Rectangle getChartBounds()

(Read only) Used to get the four sides of the Chart (Left, Top, Right and Bottom)

Specified by:

getChartBounds in interface IBaseChart

Returns:

Rectangle

setChartBounds

public void setChartBounds(Rectangle value)

Sets the four sides of the Chart (Left, Top, Right and Bottom)

Parameters:

value - Rectangle

getWidth

public int getWidth()

The Chart width in pixels.

Specified by:

getWidth in interface IBaseChart

Returns:

int

setWidth

public void setWidth(int value)

Sets the Chart width in pixels.

Specified by:

setWidth in interface IBaseChart

Parameters:

value - int

getHeight

public int getHeight()

The Chart Height in pixels.

Specified by:

getHeight in interface IBaseChart

Returns:

int

setHeight

public void setHeight(int value)

Sets the Chart Height in pixels.

Specified by:

setHeight in interface IBaseChart

Parameters:

value - int

getLeft

public int getLeft()

Specified by:

getLeft in interface IBaseChart

getRight

public int getRight()

Specified by:

getRight in interface IBaseChart

getTop

public int getTop()

Specified by:

getTop in interface IBaseChart

getChartRectBottom

protected int getChartRectBottom()

chartRectWidth

protected int chartRectWidth()

chartRectHeight

protected int chartRectHeight()

doChangedBrush

public void doChangedBrush(ChartBrush value)

Specified by:

doChangedBrush in interface IBaseChart

doChangedFont

public void doChangedFont(ChartFont value)

Specified by:

doChangedFont in interface IBaseChart

canDrawPanelBack

public boolean canDrawPanelBack()

Specified by:

canDrawPanelBack in interface IBaseChart

getPrinting

public boolean getPrinting()

Determines when Chart is being printed.

Specified by:

getPrinting in interface IBaseChart

Returns:

boolean

setPrinting

public void setPrinting(boolean value)

Determines when Chart is being printed.

Specified by:

setPrinting in interface IBaseChart

Parameters:

value - boolean

setCancelMouse

public void setCancelMouse(boolean value)

Specified by:

setCancelMouse in interface IBaseChart

changeSeriesType

public static Series changeSeriesType(Series series,
                                      java.lang.Class newClass)

changeAllSeriesType

public static void changeAllSeriesType(Chart chart,
                                       java.lang.Class newClass)

removeAllComponents

protected void removeAllComponents()

getListeners

public TeeEventListeners getListeners()

Returns array list of objects that implement the TeeEventListener interface.

Returns:

TeeEventListeners

removeListener

protected void removeListener(ITeeEventListener sender)

isValidDataSource

public boolean isValidDataSource(Series s,
                                 java.lang.Object source)

restoreAxisScales

public void restoreAxisScales()

Specified by:

restoreAxisScales in interface IBaseChart

getNumPages

public int getNumPages()

Specified by:

getNumPages in interface IBaseChart

getToolTip

public ToolTip getToolTip()

Displays a text box at the cursor.

Specified by:

getToolTip in interface IBaseChart

Returns:

ToolTip

activeSeriesLegend

public Series activeSeriesLegend(int itemIndex)

Returns the Active series (visible) that corresponds to the ItemIndex position in the Legend.
When the Legend style is "Series", returns the series that corresponds to the Legend "ItemIndex" position. The "OnlyActive" parameter, when false takes into account all series, visibly active or not.

Specified by:

activeSeriesLegend in interface IBaseChart

Parameters:

itemIndex - int

Returns:

Series that corresponds to the ItemIndex position in the Legend

getSeriesTitleLegend

public java.lang.String getSeriesTitleLegend(int seriesIndex,
                                             boolean onlyActive)

Returns the Series.Title string.

Specified by:

getSeriesTitleLegend in interface IBaseChart

Parameters:

seriesIndex - int

onlyActive - boolean

Returns:

String

internalDraw

protected void internalDraw(IGraphics3D g)

Main drawing procedure. Paints all Chart contents.

Parameters:

g - IGraphics3D

getZoom

public Zoom getZoom()

Accesses the Zoom characteristics of the Chart.

Returns:

Zoom

setZoom

public void setZoom(Zoom zoom)

getPanning

public Scroll getPanning()

Sets the scrolling direction or denies scrolling.

Returns:

Scroll

setPanning

public void setPanning(Scroll panning)

checkZoomPanning

protected void checkZoomPanning(java.awt.event.MouseEvent e)

broadcastMouseEvent

protected void broadcastMouseEvent(java.awt.event.MouseEvent e)

broadcastMouseEvent

protected java.awt.Cursor broadcastMouseEvent(java.awt.event.MouseEvent e,
                                              java.awt.Cursor c)

broadcastToolEvent

protected void broadcastToolEvent(ChartDrawEvent ce)

broadcastEvent

public void broadcastEvent(TeeEvent event)

Specified by:

broadcastEvent in interface IBaseChart

broadcastEvent

public TeeEvent broadcastEvent(Series s,
                               SeriesEventStyle e)

Specified by:

broadcastEvent in interface IBaseChart

getSeriesIndexOf

public int getSeriesIndexOf(Series value)

Specified by:

getSeriesIndexOf in interface IBaseChart

getSeries

public SeriesCollection getSeries()

Collection of Series contained in this Chart.

Returns:

SeriesCollection

getSeries

public Series getSeries(int seriesIndex)

Specified by:

getSeries in interface IBaseChart

setSeries

public void setSeries(SeriesCollection value)

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

mouseMoved

public java.awt.Cursor mouseMoved(java.awt.event.MouseEvent e)

doMouseMove

public java.awt.Cursor doMouseMove(int x,
                                   int y,
                                   java.awt.Cursor c)

doZoom

public void doZoom(double topx,
                   double topy,
                   double bottomx,
                   double bottomy,
                   double leftx,
                   double lefty,
                   double rightx,
                   double righty)

Specified by:

doZoom in interface IBaseChart

doZoom

public void doZoom(java.awt.geom.Point2D.Double top,
                   java.awt.geom.Point2D.Double bot,
                   java.awt.geom.Point2D.Double lef,
                   java.awt.geom.Point2D.Double rig)

Specified by:

doZoom in interface IBaseChart

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

undoZoom

public void undoZoom()

Obsolete. Please use tChart1.Zoom.Undo method.

setBrushCanvas

public void setBrushCanvas(Color aColor,
                           ChartBrush aBrush,
                           Color aBackColor)

Specified by:

setBrushCanvas in interface IBaseChart

canClip

public boolean canClip()

Returns the number of active (visible) series.
CanClip returns if the Chart Drawing Canvas has the capability of "clipping" lines and polygons.
"Clipping" means the feature that allows hiding drawing outside the rectangle or polygon specifed by the developer.
CanClip returns false when the Chart is displayed in OpenGL 3D, or when the Chart is printed and the TeeClipWhenPrinting constant is true, or when the Chart is converted to a metafile image and the TeeClipWhenMetafiling constant is true.
By default all display drivers and printers support clipping. You can turn off the clipping constants in case the printer or display driver has a bug related to clipping.
See also:
ClipPoints, TeeClipWhenPrinting, TeeClipWhenMetafiling, ClipCanvas, UnClipCanvas, ClipRoundRectangle and ClipPolygon.

Specified by:

canClip in interface IBaseChart

Returns:

boolean

recalcWidthHeight

public Rectangle recalcWidthHeight(Rectangle r)

Specified by:

recalcWidthHeight in interface IBaseChart

getAxisSeries

public Series getAxisSeries(Axis axis)

Returns the first Series that depends on the specified Axis.
If no Series depends on Axis, the null value is returned.

Parameters:

axis - Axis

Returns:

Series

internalMinMax

public double internalMinMax(Axis aAxis,
                             boolean isMin,
                             boolean isX)

Specified by:

internalMinMax in interface IBaseChart

maxTextWidth

public int maxTextWidth()

Returns the Maximum width in pixels of all Series Labels, whether active or not.
This applies only to Series which have Labels.

Specified by:

maxTextWidth in interface IBaseChart

Returns:

int

maxMarkWidth

public int maxMarkWidth()

Returns the Maximum width of the Active Series Marks.
Series Marks must be Visible. This can be used to adjust the Chart Margins in order to accomodate the biggest Series Mark.

Specified by:

maxMarkWidth in interface IBaseChart

Returns:

int

multiLineTextWidth

public MultiLine multiLineTextWidth(java.lang.String s)

Specified by:

multiLineTextWidth in interface IBaseChart

getMaxXValue

public double getMaxXValue(Axis axis)

Returns the Maximum Value of the Series X Values List.

Specified by:

getMaxXValue in interface IBaseChart

Parameters:

axis - Axis

Returns:

double

getMaxYValue

public double getMaxYValue(Axis axis)

Returns the highest of all the current Series Y point values.

Specified by:

getMaxYValue in interface IBaseChart

Parameters:

axis - Axis

Returns:

double

getMinXValue

public double getMinXValue(Axis axis)

Returns the Minimum Value of the Series X Values List.

Specified by:

getMinXValue in interface IBaseChart

Parameters:

axis - Axis

Returns:

double

getMinYValue

public double getMinYValue(Axis axis)

Returns the Minimum Value of the Series Y Values List.

Specified by:

getMinYValue in interface IBaseChart

Parameters:

axis - Axis

Returns:

double

isFreeSeriesColor

public boolean isFreeSeriesColor(Color color,
                                 boolean checkBackground)

Returns whether the AColor parameter is used by any Series or not.

Parameters:

color - Color

checkBackground - boolean When true, uses current Chart background

Returns:

boolean

freeSeriesColor

public Color freeSeriesColor(boolean checkBackground)

Returns a color from the default color palette not used by any Series.
The CheckBackGround parameter controls if the returned color should or shouldn't be the Chart BackColor color. This function returns a Color which is not used by any Series in the Chart.

Specified by:

freeSeriesColor in interface IBaseChart

Parameters:

checkBackground - boolean

Returns:

Color

paint

public void paint(IGraphics3D g,
                  Rectangle rect)

Paints the Chart in your preferred Canvas and region.

Specified by:

paint in interface IBaseChart

Parameters:

g - IGraphics3D

rect - Rectangle

paint

public void paint()

paint

public void paint(IGraphics3D g)

Paints the Chart on the Drawing Canvas g.

Specified by:

paint in interface IBaseChart

Parameters:

g - IGraphics3D

paint

public void paint(IGraphics3D g,
                  int width,
                  int height)

getItem

public Series getItem(int index)

Default indexer.
Example: tChart1[0].Color=Color.Blue; is equivalent to tChart1.Series[0].Color=Color.Blue;

Parameters:

index - int

Returns:

Series

setItem

public void setItem(int index,
                    Series value)

Default indexer.

Parameters:

index - int

value - Series

isAxisVisible

public boolean isAxisVisible(Axis a)

Specified by:

isAxisVisible in interface IBaseChart

getFirstActiveSeries

public Series getFirstActiveSeries()

Returns first active (visible) series.

Specified by:

getFirstActiveSeries in interface IBaseChart

Returns:

Series

formattedValueLegend

public java.lang.String formattedValueLegend(Series aSeries,
                                             int valueIndex)

Returns the String to display at Legend for a given series and point index.
In other words it returns the string representation of a Series Point value just as it would appear in Chart.Legend. The ValueIndex parameter is the point index. Legend.TextStyle and all other TChartLegend methods are used to create the resulting string.

Specified by:

formattedValueLegend in interface IBaseChart

Parameters:

aSeries - Series

valueIndex - int

Returns:

String

doDrawLegend

public Rectangle doDrawLegend(IGraphics3D g,
                              Rectangle tmp)

Specified by:

doDrawLegend in interface IBaseChart

countActiveSeries

public int countActiveSeries()

Returns the number of active (visible) series.
In other words it is a count of Series in Chart that have their Active property set to true.

Specified by:

countActiveSeries in interface