com.jinsight.jetchart
Class ScatterSerie

java.lang.Object
  |
  +--com.jinsight.jetchart.AbstractSerie
        |
        +--com.jinsight.jetchart.ScatterSerie
Direct Known Subclasses:
BubbleSerie, XYImageSerie, XYLineSerie, XYSerie

public abstract class ScatterSerie
extends AbstractSerie

This class implements the properties common to scatter series. Data points of scatter series are associated with two values each, representing a xy pair which is plotted against a horizontal and a a vertical scales using the cartesian coordinates system. ScatterSerie is extended to implement more specialized series.

See Also:
AbstractSerie, XYSerie, XYLineSerie, BubbleSerie

Fields inherited from class com.jinsight.jetchart.AbstractSerie
CLIENT_SIDE, SERVER_SIDE_CERN, SERVER_SIDE_NCSA
 
Method Summary
protected  void finalize()
           
 java.awt.Color getColor()
          Returns the color of this series.
 RegressionLine getRegressionLine()
          Returns a reference to a RegressionLine object.
 java.lang.String getSerieMap(java.lang.String[] urls, int type, java.lang.String target)
          Creates a chart image map.
 void removeRegressionLine()
          Removes the regression line object.
 void setColor(java.awt.Color color)
          Sets series color.
 void setMultipleValues(double[][] multipleValues)
          Sets the values of series whose data points are associated with multiple values, as OHLC series and scatter series.
 void setTitle(java.lang.String title)
          Sets series title.
 void setToolTipText(java.lang.String[] toolTipText)
          Sets the texts to prefix values displayed in tooltips.
 void setValuesFormat(java.lang.String[] valuesFormat)
          Sets the format of the x, y and z(bubble series) values, displayed in tooltips.
 
Methods inherited from class com.jinsight.jetchart.AbstractSerie
getId, getMultipleValues, getValues, setHighlightColor, setHighlightEnabled, setId, setLegendEnabled, setMultipleValues, setSVGURLs, setToolTipContent, setToolTipEnabled, setValueFormat, setValues, setValues, setValuesQuery
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setMultipleValues

public void setMultipleValues(double[][] multipleValues)
Description copied from class: AbstractSerie
Sets the values of series whose data points are associated with multiple values, as OHLC series and scatter series. Multiple values must be passed as a bidimensional array of double precision numbers.
Overrides:
setMultipleValues in class AbstractSerie
Following copied from class: com.jinsight.jetchart.AbstractSerie
Parameters:
multipleValues - A bidimensional array of double precision numbers.
See Also:
OHLCSerie, ScatterSerie

setTitle

public void setTitle(java.lang.String title)
Sets series title. The series title identifies a series, and it is displayed inside the legend box.
Parameters:
title - A String object.
See Also:
Legend

setColor

public void setColor(java.awt.Color color)
Sets series color. The series color is Color.lightGray by default.
Parameters:
color - A Color object.

getColor

public java.awt.Color getColor()
Returns the color of this series.
Returns:
A Color object.
See Also:
setColor(java.awt.Color)

setToolTipText

public void setToolTipText(java.lang.String[] toolTipText)
Sets the texts to prefix values displayed in tooltips. Default prefixes are:
"X:" and "Y:".
Bubble series take a third prefix to identify the z value, and the default prefixes are "X:", "Y:" and "Z:".
Parameters:
toolTipText - An array of String objects.
See Also:
BubbleSerie

setValuesFormat

public void setValuesFormat(java.lang.String[] valuesFormat)
Sets the format of the x, y and z(bubble series) values, displayed in tooltips. Default format is "#,###,##0.00", numbers are displayed with two decimals.
Parameters:
valuesFormat - An array of String objects.
See Also:
ToolTip

getSerieMap

public java.lang.String getSerieMap(java.lang.String[] urls,
                                    int type,
                                    java.lang.String target)
Description copied from class: AbstractSerie
Creates a chart image map. A image map is used in an HTML document to allow regions of an image to be linked to other HTML documents. The web browser will bring up a different document depending where on the image map the user clicks. The map itself is either a separate file (server-side maps) or part of the HTML document (client-side maps).
A client-side map can be inserted into html text to be returned by a servlet that also generates the chart image.
If the 'urls' parameter is informed, data points coordinates are associated with each element found in the array of urls. If hyperlinks are not required set the 'urls' parameter to null.
The second parameter sets the map format type. Image map can be generated in three different formats. A client-side map and an NCSA server or CERN server formatted map. The client-side map is the most used format.
The third parameter sets a target. The target is the name of an html frame used to display the page associated with the image map. This parameter is only related to client-side image mapping. If a target frame is not required set the 'target' parameter to null.
Overrides:
getSerieMap in class AbstractSerie
Following copied from class: com.jinsight.jetchart.AbstractSerie
Parameters:
urls - An array of strings containing valid urls.
type - An integer representing the format type.
target - A string object.
See Also:
AbstractSerie.CLIENT_SIDE, AbstractSerie.SERVER_SIDE_NCSA, AbstractSerie.SERVER_SIDE_CERN

getRegressionLine

public RegressionLine getRegressionLine()
Returns a reference to a RegressionLine object. A RegressionLine object is created by a scatter series only when this method is invoked.
Returns:
a RegressionLine object.
See Also:
RegressionLine, removeRegressionLine()

removeRegressionLine

public void removeRegressionLine()
Removes the regression line object. A single instance of a RegressionLine is created by a scatter series object when the method getRegressionLine() is invoked. Invoke this method to get rid of the RegressionLine object.
See Also:
getRegressionLine()

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class AbstractSerie