Chart Builder API (beta)

oracle.ord.media.chart.types
Class SeriesDesc

java.lang.Object
  |
  +--oracle.ord.media.chart.types.SeriesDesc

public class SeriesDesc
extends java.lang.Object

SeriesDesc objects are used in interactive applications to return information related to the series name and index in response to mouse events.

A series descriptor contains a seriesName, identifying one of possibly many series, and a seriesIndex, identifying the element of the series.

Users typically need call only the get methods (getSeriesIndex() and getSeriesName()).

See Also:
AxisChartInteractive.getSeriesIndex(int, int)

Constructor Summary
SeriesDesc()
           
 
Method Summary
 int getSeriesIndex()
          Return the series index.
 java.lang.String getSeriesName()
          Return the series name.
 void setSeriesIndex(int index)
          Set the series index.
 void setSeriesName(java.lang.String seriesName)
          Set the series name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SeriesDesc

public SeriesDesc()
Method Detail

setSeriesIndex

public void setSeriesIndex(int index)
Set the series index. Note: -1 indicates an invalid series.
Parameters:
index - Index of series element, [-1, 0, 1, ..., seriesLength -1]

getSeriesIndex

public int getSeriesIndex()
Return the series index.

setSeriesName

public void setSeriesName(java.lang.String seriesName)
Set the series name.
Parameters:
seriesName - Name of series.

getSeriesName

public java.lang.String getSeriesName()
Return the series name.

Chart Builder API (beta)