com.jinsight.jetchart
Class PolarBubbleSerie

java.lang.Object
  com.jinsight.jetchart.AbstractSerie
      com.jinsight.jetchart.PolarSerie
          com.jinsight.jetchart.PolarBubbleSerie

public class PolarBubbleSerie

extends PolarSerie

This class implements the properties and methods of a polar bubble series. A polar bubble series is similar to the other types of polar series, in that each data point has its position defined in terms of a radius length(r) and an angle(theta). A polar bubble series, however, has a third value, the z value, associated with a data point, to specify the size of bubbles (color filled circles) painted centered on the polar coordinates.

See Also:

PolarSerie

Field Summary

static int	ALL_SERIES Constant used to set the scope of the calculation of the maximum z value to all polar bubble series instances.
static int	SERIES Constant used to set the scope of the calculation of the maximum z value to a polar bubble series instance.

Fields inherited from class com.jinsight.jetchart.AbstractSerie

CLIENT_SIDE, SERVER_SIDE_CERN, SERVER_SIDE_NCSA

Constructor Summary

PolarBubbleSerie()
Creates a PolarBubbleSerie object.

PolarBubbleSerie(double[][] multipleValues)
Creates a PolarBubbleSerie object.

PolarBubbleSerie(double[][] multipleValues, java.lang.String title)
Creates a PolarBubbleSerie object.

Method Summary

java.lang.String	getSerieMap(java.lang.String[] urls, int type, java.lang.String target) Creates a chart image map.
void	setCenterPointColor(java.awt.Color centerPointColor) Sets the color of the center point.
void	setCenterPointEnabled(boolean isCenterPointEnabled) Enables/disables the center point.
void	setColors(java.awt.Color[] colors) Sets a color to each bubble.
void	setMaxDiameter(int maxDiameter) Sets the largest diameter of a polar bubble series.
static void	setMaxZValueScope(int maxZValueScope) Sets the scope in which the maximum z value is calculated.

Methods inherited from class com.jinsight.jetchart.PolarSerie

getTitle, setColor, setDataPointLegendColor, setDataPointLegendFont, setDataPointLegends, setMultipleValues, setTitle, setToolTipText, setValuesFormat, setValuesQuery

Methods inherited from class com.jinsight.jetchart.AbstractSerie

addMultipleValues, addValue, finalize, getId, getMultipleValues, getValues, setHighlightColor, setHighlightEnabled, setId, setLegendEnabled, setMultipleValues, setSVGURLs, setToolTipContent, setToolTipEnabled, setValueFormat, setValues, setValues

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERIES

public static final int SERIES

Constant used to set the scope of the calculation of the maximum z value to a polar bubble series instance.

See Also:

setMaxZValueScope(int), Constant Field Values

ALL_SERIES

public static final int ALL_SERIES

Constant used to set the scope of the calculation of the maximum z value to all polar bubble series instances.

See Also:

setMaxZValueScope(int), Constant Field Values

Constructor Detail

PolarBubbleSerie

public PolarBubbleSerie()

Creates a PolarBubbleSerie object. Default constructor.

PolarBubbleSerie

public PolarBubbleSerie(double[][] multipleValues)

Creates a PolarBubbleSerie object. This constructor takes a bidimensional array of double values. Each subarray has three values corresponding to the radius(r), angle(theta) and z values.

Parameters:

multipleValues - Bidimensional array of double precision numbers.

PolarBubbleSerie

public PolarBubbleSerie(double[][] multipleValues,
                        java.lang.String title)

Creates a PolarBubbleSerie object. This constructor takes a bidimensional array of double values and the series title. Each subarray of the bidimensional array has three values corresponding to the radius(r), angle(theta) and z values.

Parameters:

multipleValues - Array of double precision numbers.

title - A String object. The series title is displayed inside the legend box.

Method Detail

setMaxDiameter

public void setMaxDiameter(int maxDiameter)

Sets the largest diameter of a polar bubble series. The largest diameter is assigned to the data point with the maximum z value. All the other data points have their diameters calculated with respect to the largest diameter. The scope in which the diameters are calculated is delimited by the range of data points belonging to a polar bubble series object.

The largest diameter is 50 pixels by default.

Parameters:

maxDiameter - An integer value.

See Also:

setMaxZValueScope(int)

setMaxZValueScope

public static void setMaxZValueScope(int maxZValueScope)

Sets the scope in which the maximum z value is calculated. If the scope is set to ALL_SERIES, the maximum z value is selected among the z values of all polar bubble series added to the chart context. The diameter of the bubbles of all polar bubble series are calculated with respect to this common maximum z value.
If the scope is set to SERIES, the maximum z value is selected among the z values of a PolarBubbleSerie object. In such case, two or more polar bubble series have their largest bubbles with the same diameter value. Default value is SERIES.
The largest diameter is an instance property, so, if the scope is set to ALL_SERIES, the largest diameter is the diameter selected among the largest diameter of all polar bubble series.

Parameters:

maxZValueScope - An integer value.

See Also:

ALL_SERIES, SERIES, setMaxDiameter(int)

setColors

public void setColors(java.awt.Color[] colors)

Sets a color to each bubble. The color of a bubble is that with the same index of the bubble's respective value entry in the bidimensional array passed to the method setMultipleValues. A null entry causes the respective bubble to be painted in the default color or the color passed to the method setColor.

Parameters:

colors - An array of Color objects.

See Also:

PolarSerie.setColor(java.awt.Color), PolarSerie.setMultipleValues(double[][])

setCenterPointEnabled

public void setCenterPointEnabled(boolean isCenterPointEnabled)

Enables/disables the center point. The center point is disabled by default.

Parameters:

isCenterPointEnabled - A boolean value.

See Also:

setCenterPointColor(java.awt.Color)

setCenterPointColor

public void setCenterPointColor(java.awt.Color centerPointColor)

Sets the color of the center point. Default color is black.

Parameters:

centerPointColor - A Color object.

See Also:

setCenterPointEnabled(boolean)

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 on the image map link the user clicks on. 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 PolarSerie