ISeries

All Known Implementing Classes:

AbstractSeries, CSVSeries, FakeSeries, ProxySeries
```
public interface ISeries
```
The ISeries interface defines the set of methods necessary to describe a series in ICE used for plotting on an IPlot. The ISeries type should be able to provide all of the information for plotting on the platform, including the type and style of the series.

Author:

Kasper Gammeltoft

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double[]`	`getBounds()` Gets the bounds for this series.
`java.lang.String`	`getCategory()` Gets the current category that this series is in
`java.lang.Object[]`	`getDataPoints()` Gets all of the data points for this series, used to plot the series no matter what visualization service is being used.
`java.lang.String`	`getLabel()` Gets the label used to describe this series and to be shown on the graphs.
`ISeries`	`getParentSeries()` Gets the parent series for this series.
`ISeriesStyle`	`getStyle()` Sets the `ISeriesStyle` of the series.
`double`	`getTime()` Gets the timestamp for this series.
`boolean`	`isEnabled()` Gets if this series is enabled or not.
`void`	`setEnabled(boolean enable)` Sets the enabled state of this series.
`void`	`setLabel(java.lang.String label)` Sets the label used to describe this series and to be shown on the graphs.
`void`	`setStyle(ISeriesStyle style)` Sets the `ISeriesStyle` used for this series.
`void`	`setTime(double time)` Sets the time for this series to the specified time.

- Method Detail
  - getBounds
```
double[] getBounds()
```
    Gets the bounds for this series. The bounds are described as the minimum value, maximum value, and the difference between the two. The array returned is a representation of these values by using two doubles. The first value is the minimum in the series. The second is the difference between the minimum and maxiumum values in the series, or the algebraic range. The maxiumum can then be easily calculated with the addition of the two numbers provided. Note- will return null if the ISeries was established but no data was ever added to it (see ISeries#add(double)).
    
    Returns:
    
    double[] The bounds of the series, as given by double[2] {minValue, range} where the first value is the min value and the second is the range of the series.
  - getCategory
```
java.lang.String getCategory()
```
    Gets the current category that this series is in
    
    Returns:
  - getDataPoints
```
java.lang.Object[] getDataPoints()
```
    Gets all of the data points for this series, used to plot the series no matter what visualization service is being used. It is up to the service to know what type of objects are being stored in the array and caste appropriately.
    
    Returns:
    
    Object[] An array containing all of the data points for this series.
  - getLabel
```
java.lang.String getLabel()
```
    Gets the label used to describe this series and to be shown on the graphs. This is the name of the series.
    
    Returns:
    
    String the series label.
  - getParentSeries
```
ISeries getParentSeries()
```
    Gets the parent series for this series. This allows for grouping of series and for one to be of direct relation to another. For example, a certain series could be the error of another series, and their relationship could be established in this way.
    
    Returns:
    
    ISeries The parent series to this one.
  - getStyle
```
ISeriesStyle getStyle()
```
    Sets the ISeriesStyle of the series. That style defines the color, point style, line style, default preferred axis, and many other types of style information for the series to be properly formatted when being plotted. This allows for some configuration rather than the default plot implementation to be used for every plotting purpose.
    
    Returns:
  - getTime
```
double getTime()
```
    Gets the timestamp for this series.
    
    Returns:
    
    int The time for this series.
  - isEnabled
```
boolean isEnabled()
```
    Gets if this series is enabled or not. This determines which series is plotted when they are added to different plots.
    
    Returns:
    
    True if the series is enabled and will be shown on a plot, false if otherwise
  - setEnabled
```
void setEnabled(boolean enable)
```
    Sets the enabled state of this series. This determines if the series will be drawn.
    
    Parameters:
    
    enable - The state of the series. True will enable the series for plotting, false will disable the series.
  - setLabel
```
void setLabel(java.lang.String label)
```
    Sets the label used to describe this series and to be shown on the graphs. This is the name of the series.
    
    Parameters:
    
    label - The series label
  - setStyle
```
void setStyle(ISeriesStyle style)
```
    Sets the ISeriesStyle used for this series. That style defines the color, point style, line style, default preferred axis, and many other types of style information for the series to be properly formatted when being plotted. This allows for some configuration rather than the default plot implementation to be used for every plotting purpose.
    
    Parameters:
    
    style -
  - setTime
```
void setTime(double time)
```
    Sets the time for this series to the specified time. Should be greater than or equal to 0.
    
    Parameters:
    
    time - The time for this series.

Interface ISeries

Method Summary

Method Detail

getBounds

getCategory

getDataPoints

getLabel

getParentSeries

getStyle

getTime

isEnabled

setEnabled

setLabel

setStyle

setTime