org.swtchart.ISeries Interface Reference

Series. More...

Inheritance diagram for org.swtchart.ISeries:

[legend]

List of all members.

Public Types
enum	SeriesType { LINE = ("Line"), BAR = ("Bar") }
	A Series type. More...
Public Member Functions
String	getId ()
	Gets the series id.
void	setVisible (boolean visible)
	Sets the visibility state.
boolean	isVisible ()
	Gets the visibility state.
SeriesType	getType ()
	Gets the series type.
void	enableStack (boolean enabled)
	Enables the stack series.
boolean	isStackEnabled ()
	Gets the state indicating if stack is enabled.
void	setXSeries (double[] series)
	Sets the X series.
void	setYSeries (double[] series)
	Sets the Y series.
double[]	getXSeries ()
	Gets the X series.
double[]	getYSeries ()
	Gets the Y series.
void	setXDateSeries (Date[] series)
	Sets the X date series.
Date[]	getXDateSeries ()
	Gets the X date series.
int	getXAxisId ()
	Gets the X axis id.
void	setXAxisId (int id)
	Sets the X axis id.
int	getYAxisId ()
	Gets the Y axis id.
void	setYAxisId (int id)
	Sets the Y axis id.
IErrorBar	getXErrorBar ()
	Gets the X error bar.
IErrorBar	getYErrorBar ()
	Gets the Y error bar.
ISeriesLabel	getLabel ()
	Gets the series label.
void	setVisibleInLegend (boolean visible)
	Sets the visibility state in legend.
boolean	isVisibleInLegend ()
	Gets the visibility state in legend.
void	setDescription (String description)
	Sets the series description.
String	getDescription ()
	Gets the series description.
Point	getPixelCoordinates (int index)
	Gets the pixel coordinates corresponding to the given series index.
void	addDisposeListener (IDisposeListener listener)
	Adds the dispose listener.

---

Detailed Description

Series.

Definition at line 16 of file ISeries.java.

---

Member Enumeration Documentation

enum org::swtchart::ISeries::SeriesType

A Series type.

Enumerator:

LINE	the line
BAR	the bar

Definition at line 21 of file ISeries.java.

---

Member Function Documentation

void org.swtchart.ISeries.addDisposeListener

(

IDisposeListener

listener

)

Adds the dispose listener.

The newly created color or font for series can be disposed with the dispose listener when they are no longer needed.

Parameters:

listener

the dispose listener

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.apply(), and org.swtchart.ext.internal.properties.SeriesLabelPage.apply().

Here is the caller graph for this function:

void org.swtchart.ISeries.enableStack

(

boolean

enabled

)

Enables the stack series.

The series has to contain only positive values.

Parameters:

enabled

true if enabling stack series

Exceptions:

IllegalStateException

if series contains negative values.

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.apply(), and org.swtchart.examples.StackSeriesExample.createChart().

Here is the caller graph for this function:

String org.swtchart.ISeries.getDescription

(

)

Gets the series description.

Returns:

the series description, or null if not set

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.internal.Legend.getLegendLabel().

Here is the caller graph for this function:

String org.swtchart.ISeries.getId

(

)

Gets the series id.

Returns:

the series id

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.apply(), org.swtchart.ext.internal.properties.SeriesLabelPage.apply(), org.swtchart.examples.advanced.SymbolBoundsExample.createChart(), org.swtchart.examples.advanced.BarBoundsExample.createChart(), org.swtchart.internal.Legend.getLegendLabel(), and org.swtchart.internal.Legend.paintControl().

Here is the caller graph for this function:

ISeriesLabel org.swtchart.ISeries.getLabel

(

)

Gets the series label.

Returns:

the series label

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesLabelPage.apply(), org.swtchart.examples.SeriesLabelExample.createChart(), and org.swtchart.ext.internal.properties.SeriesLabelPage.selectInitialValues().

Here is the caller graph for this function:

Point org.swtchart.ISeries.getPixelCoordinates

(

int

index

)

Gets the pixel coordinates corresponding to the given series index.

Parameters:

index

the series index

Returns:

the pixel coordinates

Implemented in org.swtchart.internal.series.Series.

SeriesType org.swtchart.ISeries.getType

(

)

Gets the series type.

Returns:

the series type

Implemented in org.swtchart.internal.series.Series.

int org.swtchart.ISeries.getXAxisId

(

)

Gets the X axis id.

Returns:

the X axis id

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.selectInitialValues(), and org.swtchart.internal.Legend.sort().

Here is the caller graph for this function:

Date [] org.swtchart.ISeries.getXDateSeries

(

)

Gets the X date series.

Returns:

the X date series, or empty array if X date series is not set.

Implemented in org.swtchart.internal.series.Series.

IErrorBar org.swtchart.ISeries.getXErrorBar

(

)

Gets the X error bar.

This is typically used for scatter chart.

Returns:

the X error bar

Implemented in org.swtchart.internal.series.Series.

double [] org.swtchart.ISeries.getXSeries

(

)

Gets the X series.

If the X series is not set, empty array will be returned.

Returns:

the X series

Implemented in org.swtchart.internal.series.Series.

int org.swtchart.ISeries.getYAxisId

(

)

Gets the Y axis id.

Returns:

the Y axis id

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.selectInitialValues().

Here is the caller graph for this function:

IErrorBar org.swtchart.ISeries.getYErrorBar

(

)

Gets the Y error bar.

Returns:

the Y error bar

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.examples.ErrorBarsExample.createChart().

Here is the caller graph for this function:

double [] org.swtchart.ISeries.getYSeries

(

)

Gets the Y series.

If the Y series haven't been set yet, empty array will be returned.

Returns:

the Y series

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.examples.advanced.SymbolBoundsExample.createChart(), org.swtchart.examples.advanced.BarBoundsExample.createChart(), and org.swtchart.internal.series.SeriesSet.setStackSeries().

Here is the caller graph for this function:

boolean org.swtchart.ISeries.isStackEnabled

(

)

Gets the state indicating if stack is enabled.

Returns:

the state indicating if stack is enabled

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.selectInitialValues().

Here is the caller graph for this function:

boolean org.swtchart.ISeries.isVisible

(

)

Gets the visibility state.

Returns:

true if series is visible

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.selectInitialValues().

Here is the caller graph for this function:

boolean org.swtchart.ISeries.isVisibleInLegend

(

)

Gets the visibility state in legend.

Returns:

true if series is visible in legend

Implemented in org.swtchart.internal.series.Series.

void org.swtchart.ISeries.setDescription

(

String

description

)

Sets the series description.

For example, you may store the description explaining what this series is, and display it on tool tip with mouse hover on the series.

By default, legend displays the description, when it is set.

Parameters:

description

the series description, or null to clear it

Implemented in org.swtchart.internal.series.Series.

void org.swtchart.ISeries.setVisible

(

boolean

visible

)

Sets the visibility state.

Parameters:

visible

the visibility state

Implemented in org.swtchart.internal.series.Series.

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

Here is the caller graph for this function:

void org.swtchart.ISeries.setVisibleInLegend

(

boolean

visible

)

Sets the visibility state in legend.

Parameters:

visible

the visibility state in legend

Implemented in org.swtchart.internal.series.Series.

void org.swtchart.ISeries.setXAxisId

(

int

id

)

Sets the X axis id.

Parameters:

id

the X axis id.

Implemented in org.swtchart.internal.series.Series.

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

Here is the caller graph for this function:

void org.swtchart.ISeries.setXDateSeries

(

Date[]

series

)

Sets the X date series.

X series and X date series are exclusive. X date series will be cleared by setting X series, and vice versa.

Parameters:

series

the X date series

Implemented in org.swtchart.internal.series.Series.

void org.swtchart.ISeries.setXSeries

(

double[]

series

)

Sets the X series.

Parameters:

series

the X series

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.examples.ScatterChartExample.createChart().

Here is the caller graph for this function:

void org.swtchart.ISeries.setYAxisId

(

int

id

)

Sets the Y axis id.

Parameters:

id

the Y axis id.

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.ext.internal.properties.SeriesPage.apply(), and org.swtchart.examples.MultipleAxesExample.createChart().

Here is the caller graph for this function:

void org.swtchart.ISeries.setYSeries

(

double[]

series

)

Sets the Y series.

Parameters:

series

the Y series

Implemented in org.swtchart.internal.series.Series.

Referenced by org.swtchart.examples.StepChartExample.createChart(), org.swtchart.examples.StackSeriesExample.createChart(), org.swtchart.examples.SeriesLabelExample.createChart(), org.swtchart.examples.ScatterChartExample.createChart(), org.swtchart.examples.OrientationExample.createChart(), org.swtchart.examples.MultipleAxesExample.createChart(), org.swtchart.examples.LogScaleExample.createChart(), org.swtchart.examples.LineChartExample.createChart(), org.swtchart.examples.LargeSeriesExample.createChart(), org.swtchart.examples.ErrorBarsExample.createChart(), org.swtchart.examples.CategoryExample.createChart(), org.swtchart.examples.BarChartExample.createChart(), org.swtchart.examples.AreaChartExample.createChart(), org.swtchart.examples.AngledAxisTickLabelsExample.createChart(), org.swtchart.examples.advanced.SymbolBoundsExample.createChart(), org.swtchart.examples.advanced.PxielToDataConversionExample.createChart(), org.swtchart.examples.advanced.LegendBoundsExample.createChart(), org.swtchart.examples.advanced.DataToPixelConversionExample.createChart(), org.swtchart.examples.advanced.CustomPaintListenerExample.createChart(), org.swtchart.examples.advanced.BarBoundsExample.createChart(), org.swtchart.examples.advanced.AxisTickBoundsExample.createChart(), org.swtchart.examples.ext.InteractiveChartExample.createPartControl(), test.swtchart.main.TestChart.main(), and org.swtchart.examples.ext.TestChart.main().

Here is the caller graph for this function:

---

The documentation for this interface was generated from the following file:

• org.swtchart/src/org/swtchart/ISeries.java