org.swtchart.Chart Class Reference

A chart which are composed of title, legend, axes and plot area. More...

Inheritance diagram for org.swtchart.Chart:

Collaboration diagram for org.swtchart.Chart:

Public Member Functions
	Chart (Composite parent, int style)
	Constructor.
ITitle	getTitle ()
	Gets the chart title.
ILegend	getLegend ()
	Gets the legend.
IAxisSet	getAxisSet ()
	Gets the set of axes.
Composite	getPlotArea ()
	Gets the plot area.
ISeriesSet	getSeriesSet ()
	Gets the set of series.
void	setBackground (Color color)
Color	getBackgroundInPlotArea ()
	Gets the background color in plot area.
void	setBackgroundInPlotArea (Color color)
	Sets the background color in plot area.
void	setOrientation (int orientation)
	Sets the state of chart orientation.
int	getOrientation ()
	Gets the state of chart orientation.
void	enableCompress (boolean enabled)
	Enables compressing series.
boolean	isCompressEnabled ()
	Gets the state indicating if compressing series is enabled.
void	suspendUpdate (boolean suspend)
	Suspends the update of chart appearance.
boolean	isUpdateSuspended ()
	Gets the state indicating if the update of chart appearance is suspended.
void	handleEvent (Event event)
void	updateLayout ()
	Updates the layout of chart elements.
void	update ()
void	dispose ()
void	redraw ()
void	save (String filename, int format)
	Saves to file with given format.
void	renderOffscreenImage (Image image)
	Renders off-screen image.
Private Attributes
Title	title
	the title
Legend	legend
	the legend
AxisSet	axisSet
	the set of axes
PlotArea	plotArea
	the plot area
int	orientation
	the orientation of chart which can be horizontal or vertical
boolean	compressEnabled
	the state indicating if compressing series is enabled
boolean	updateSuspended
	the state indicating if the update of chart appearance is suspended

Detailed Description

A chart which are composed of title, legend, axes and plot area.

Definition at line 32 of file Chart.java.

Constructor & Destructor Documentation

org.swtchart.Chart.Chart	(	Composite	parent,
		int	style
	)

Constructor.

Parameters:

	parent	the parent composite on which chart is placed
	style	the style of widget to construct

Definition at line 63 of file Chart.java.

References org.swtchart.Chart.axisSet, org.swtchart.Chart.compressEnabled, org.swtchart.Chart.legend, org.swtchart.Chart.orientation, org.swtchart.Chart.plotArea, org.swtchart.internal.Title.setLayoutData(), org.swtchart.Chart.title, org.swtchart.Chart.updateLayout(), and org.swtchart.Chart.updateSuspended.

Here is the call graph for this function:

Member Function Documentation

void org.swtchart.Chart.dispose ( )

Reimplemented in org.swtchart.ext.InteractiveChart.

Definition at line 335 of file Chart.java.

References org.swtchart.Chart.axisSet, org.swtchart.internal.PlotArea.dispose(), org.swtchart.internal.axis.AxisSet.dispose(), org.swtchart.internal.Legend.dispose(), org.swtchart.internal.Title.dispose(), org.swtchart.Chart.legend, org.swtchart.Chart.plotArea, and org.swtchart.Chart.title.

Referenced by org.swtchart.examples.ext.InteractiveChartExample.dispose().

Here is the call graph for this function:

Here is the caller graph for this function:

void org.swtchart.Chart.enableCompress ( boolean enabled )

Enables compressing series.

By default, compressing series is enabled, and normally there should be no usecase to disable it. However, if you suspect that something is wrong in compressing series, you can disable it to isolate the issue.

Parameters:

enabled

true if enabling compressing series

Definition at line 208 of file Chart.java.

References org.swtchart.Chart.compressEnabled.

IAxisSet org.swtchart.Chart.getAxisSet ( )

Gets the set of axes.

Returns:: the set of axes

Definition at line 109 of file Chart.java.

References org.swtchart.Chart.axisSet.

Here is the caller graph for this function:

Color org.swtchart.Chart.getBackgroundInPlotArea ( )

Gets the background color in plot area.

This method is identical with getPlotArea().getBackground().

Returns:: the background color in plot area

Definition at line 151 of file Chart.java.

References org.swtchart.Chart.plotArea.

ILegend org.swtchart.Chart.getLegend ( )

Gets the legend.

Returns:: the legend

Definition at line 100 of file Chart.java.

References org.swtchart.Chart.legend.

Referenced by org.swtchart.examples.advanced.LegendBoundsExample.createChart(), and org.swtchart.ext.internal.properties.LegendPage.LegendPage().

Here is the caller graph for this function:

int org.swtchart.Chart.getOrientation ( )

Gets the state of chart orientation.

The horizontal orientation means that X axis is horizontal as usual, while the vertical orientation means that Y axis is horizontal.

Returns:: the orientation which can be SWT.HORIZONTAL or SWT.VERTICAL

Definition at line 195 of file Chart.java.

References org.swtchart.Chart.orientation.

Referenced by org.swtchart.ext.InteractiveChart.getAxes(), org.swtchart.internal.series.Series.getPixelCoordinates(), org.swtchart.ext.InteractiveChart.handleMouseUpEvent(), org.swtchart.internal.axis.Axis.isHorizontalAxis(), org.swtchart.internal.axis.Axis.refresh(), org.swtchart.ext.internal.properties.ChartPage.selectValues(), and org.swtchart.internal.Legend.sort().

Here is the caller graph for this function:

Composite org.swtchart.Chart.getPlotArea ( )

Gets the plot area.

Returns:: the plot area

Definition at line 118 of file Chart.java.

References org.swtchart.Chart.plotArea.

Referenced by org.swtchart.internal.axis.Axis.adjustRange(), org.swtchart.internal.series.SeriesSet.compressAllSeries(), org.swtchart.examples.advanced.SymbolBoundsExample.createChart(), org.swtchart.examples.advanced.PxielToDataConversionExample.createChart(), org.swtchart.examples.advanced.DataToPixelConversionExample.createChart(), org.swtchart.examples.advanced.CustomPaintListenerExample.createChart(), org.swtchart.examples.advanced.BarBoundsExample.createChart(), org.swtchart.ext.InteractiveChart.createMenuItems(), org.swtchart.internal.series.BarSeries.getVisibleRectangle(), org.swtchart.ext.InteractiveChart.init(), org.swtchart.internal.axis.Axis.refresh(), and org.swtchart.examples.ext.InteractiveChartExample.setFocus().

Here is the caller graph for this function:

ISeriesSet org.swtchart.Chart.getSeriesSet ( )

Gets the set of series.

Returns:: the set of series

Definition at line 127 of file Chart.java.

References org.swtchart.internal.PlotArea.getSeriesSet(), and org.swtchart.Chart.plotArea.

Here is the call graph for this function:

Here is the caller graph for this function:

ITitle org.swtchart.Chart.getTitle ( )

Gets the chart title.

Returns:: the chart title

Definition at line 91 of file Chart.java.

References org.swtchart.Chart.title.

Here is the caller graph for this function:

void org.swtchart.Chart.handleEvent ( Event event )

Reimplemented in org.swtchart.ext.InteractiveChart.

Definition at line 282 of file Chart.java.

References org.swtchart.Chart.redraw(), and org.swtchart.Chart.updateLayout().

Here is the call graph for this function:

boolean org.swtchart.Chart.isCompressEnabled ( )

Gets the state indicating if compressing series is enabled.

Returns:: true if compressing series is enabled

Definition at line 217 of file Chart.java.

References org.swtchart.Chart.compressEnabled.

Referenced by org.swtchart.internal.series.SeriesSet.compressAllSeries().

Here is the caller graph for this function:

boolean org.swtchart.Chart.isUpdateSuspended ( )

Gets the state indicating if the update of chart appearance is suspended.

Returns:: true if the update of chart appearance is suspended

Definition at line 275 of file Chart.java.

References org.swtchart.Chart.updateSuspended.

Referenced by org.swtchart.internal.series.SeriesSet.updateStackAndRiserData().

Here is the caller graph for this function:

void org.swtchart.Chart.redraw ( )

Definition at line 347 of file Chart.java.

Referenced by org.swtchart.Chart.handleEvent(), org.swtchart.ext.InteractiveChart.handleKeyDownEvent(), org.swtchart.ext.InteractiveChart.handleMouseMoveEvent(), org.swtchart.ext.InteractiveChart.handleMouseUpEvent(), org.swtchart.ext.InteractiveChart.handleMouseWheel(), org.swtchart.ext.InteractiveChart.handleSelectionEvent(), and org.swtchart.ext.internal.properties.AbstractPage.performOk().

Here is the caller graph for this function:

void org.swtchart.Chart.renderOffscreenImage ( Image image )

Renders off-screen image.

Parameters:

image

The image to render off-screen

Definition at line 382 of file Chart.java.

void org.swtchart.Chart.save	(	String	filename,
		int	format
	)

Saves to file with given format.

Parameters:

	filename	the file name
	format	the format (SWT.IMAGE_*). The supported formats depend on OS.

Definition at line 362 of file Chart.java.

Referenced by org.swtchart.ext.InteractiveChart.openSaveAsDialog().

Here is the caller graph for this function:

void org.swtchart.Chart.setBackground ( Color color )

Definition at line 135 of file Chart.java.

Referenced by org.swtchart.ext.internal.properties.ChartPage.apply().

Here is the caller graph for this function:

void org.swtchart.Chart.setBackgroundInPlotArea ( Color color )

Sets the background color in plot area.

Parameters:

color the background color in plot area. If null is given, default background color will be set.

Exceptions:

IllegalArgumentException

if given color is disposed

Definition at line 164 of file Chart.java.

References org.swtchart.Chart.plotArea, and org.swtchart.internal.PlotArea.setBackground().

Referenced by org.swtchart.ext.internal.properties.ChartPage.apply().

Here is the call graph for this function:

Here is the caller graph for this function:

void org.swtchart.Chart.setOrientation ( int orientation )

Sets the state of chart orientation.

The horizontal orientation means that X axis is horizontal as usual, while the vertical orientation means that Y axis is horizontal.

Parameters:

orientation

the orientation which can be SWT.HORIZONTAL or SWT.VERTICAL

Definition at line 180 of file Chart.java.

References org.swtchart.Chart.updateLayout().

Referenced by org.swtchart.ext.internal.properties.ChartPage.apply(), and org.swtchart.examples.OrientationExample.createChart().

Here is the call graph for this function:

Here is the caller graph for this function:

void org.swtchart.Chart.suspendUpdate ( boolean suspend )

Suspends the update of chart appearance.

By default, when the chart model is changed (e.g. adding new series or changing chart properties), the chart appearance is updated accordingly.

However, when doing a lot of changes in the chart model at once, it is inefficient that the update happens many times unnecessarily. In this case, you may want to defer the update until completing whole model changes in order to have better performance.

For example, suppose there is a chart having a large number of series, the following example code disables the update during changing the model.

 try {
     // suspend update
     chart.suspendUpdate(true);

     // do some changes for a large number of series
     for (ISeries series : chart.getSeriesSet().getSeries()) {
         series.enableStack(true);
     }
 } finally {
     // resume update
     chart.suspendUpdate(false);
 }

Note that the update has to be resumed right after completing the model changes in order to avoid showing an incompletely updated chart.

Parameters:

suspend

true to suspend the update of chart appearance

Definition at line 257 of file Chart.java.

References org.swtchart.Chart.getSeriesSet(), org.swtchart.Chart.updateLayout(), and org.swtchart.Chart.updateSuspended.

Here is the call graph for this function: