com.jinsight.jetchart
Class VectorSerie

java.lang.Object
  com.jinsight.jetchart.AbstractSerie
      com.jinsight.jetchart.GraphSerie
          com.jinsight.jetchart.VectorSerie

public class VectorSerie

extends GraphSerie

This class implements the properties and methods of a vector series. A vector series is a sequence of arrows(vectors) pointing to specific directions. The direction of each vector is defined by assigning an angle value in degrees to each data point. The angle ranges from 0 to 360 degrees, and the start position of a vector line is calculated with respect to a base line.
The position of a base line corresponds to a value calculated against the scale of the GraphSet one or more vector series belong to, and it has to be explicitily set.
Charts displaying vector series are always vertical and 2D. Additionally, vector series do not support legends on data points.

Field Summary

static int	EMPTY Constant used to set an arrow style to EMPTY.
static int	SOLID Constant used to set an arrow style to SOLID.

Fields inherited from class com.jinsight.jetchart.GraphSerie

ABOVE_TOP_YAXIS, AREA, BAR, BAR_HLC, BAR_OHLC, BESIDE_TOP_YAXIS, CANDLESTICK, DASHED, EMPTY_CIRCLE_MARK, EMPTY_DIAMOND_MARK, EMPTY_SQUARE_MARK, EMPTY_TRIANGLE_MARK, IMAGE, LEGEND, LINE, LINE_HLC, LINE_OHLC, MARK_SHAPE_LEGEND, POINT, ROUNDED_CANDLESTICK, SOLID_CIRCLE_MARK, SOLID_DIAMOND_MARK, SOLID_SQUARE_LEGEND, SOLID_SQUARE_MARK, SOLID_TRIANGLE_MARK, STACKED_BAR, VECTOR, X_MARK

Fields inherited from class com.jinsight.jetchart.AbstractSerie

CLIENT_SIDE, SERVER_SIDE_CERN, SERVER_SIDE_NCSA

Constructor Summary

VectorSerie()
Creates a VectorSerie object.

VectorSerie(double[] values)
Creates a VectorSerie object.

VectorSerie(double[] values, java.lang.String title)
Creates a VectorSerie object.

Method Summary

protected void	finalize()
void	setArrowBorderColor(java.awt.Color arrowBorderColor) Sets the color of a vector's arrow border.
void	setArrowBorderEnabled(boolean isArrowBorderEnabled) Enables/disables a border surrounding a vector's arrow.
void	setArrowLength(int arrowLength) Sets the length of a vector's arrow.
void	setArrowStyle(int arrowStyle) Sets the arrow style.
void	setArrowWidth(int arrowWidth) Sets the width of a vector's arrow.
void	setBaseLineColor(java.awt.Color baseLineColor) Sets the color of a vector series base line.
void	setBaseLineEnabled(boolean isBaseLineEnabled) Enables/disables the base line of a vector series.
void	setBaseLineValue(double baseLineValue) Sets the value of the vector series base line.
void	setCardinalPointsEnabled(boolean isCardinalPointsEnabled) Enables/disables data reading as the cardinal points of a wind rose.
void	setLength(int length) Sets the length of a vector's line.

Methods inherited from class com.jinsight.jetchart.GraphSerie

getColor, getMultipleValues, getRegressionLine, getSerieMap, getSerieMap, getSerieMap, getTitle, getType, getValues, removeRegressionLine, setColor, setCoordinatesStatus, setFont, setMarkLegendBackground, setMarkLegendEnabled, setMarkLegendForeground, setMarkLegendOpacityEnabled, setMarksColor, setMarksEnabled, setMarksHeight, setMarksStyle, setMarksWidth, setMultipleValues, setStartPoint, setTitle, setTitleFont, setTitlePosition, setToolTipContent, setValues, setValuesQuery

Methods inherited from class com.jinsight.jetchart.AbstractSerie

addMultipleValues, addValue, getId, setHighlightColor, setHighlightEnabled, setId, setLegendEnabled, setMultipleValues, setSVGURLs, setToolTipEnabled, setValueFormat, setValues

Methods inherited from class java.lang.Object

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

Field Detail

SOLID

public static final int SOLID

Constant used to set an arrow style to SOLID.

See Also:

Constant Field Values

EMPTY

public static final int EMPTY

Constant used to set an arrow style to EMPTY.

See Also:

Constant Field Values

Constructor Detail

VectorSerie

public VectorSerie()

Creates a VectorSerie object. Default constructor.

VectorSerie

public VectorSerie(double[] values)

Creates a VectorSerie object. This constructor takes an array of double precision numbers containing the degrees of all vectors to be displayed. The degrees are measured counterclockwise from 0 to 360, the 0 degree corresponding to a horizontal vector pointing to the right.

Parameters:

values - Array of double precision numbers.

See Also:

setCardinalPointsEnabled(boolean)

VectorSerie

public VectorSerie(double[] values,
                   java.lang.String title)

Creates a VectorSerie object. This constructor takes an array of double precision numbers containing the degrees of all vectors to be displayed and the series title. The degrees are measured counterclockwise from 0 to 360, the 0 degree corresponding to a horizontal vector pointing to the right.

Parameters:

values - Array of double precision numbers.

title - A String object.

See Also:

setCardinalPointsEnabled(boolean)

Method Detail

setBaseLineValue

public void setBaseLineValue(double baseLineValue)

Sets the value of the vector series base line. This value is used to calculate the position of the vectors base line against the scale of the GraphSet object one or more VectorSerie objects belong to.

Parameters:

baseLineValue - A double precision number.

setBaseLineColor

public void setBaseLineColor(java.awt.Color baseLineColor)

Sets the color of a vector series base line. Default color is black.

Parameters:

baseLineColor - A Color object.

See Also:

setBaseLineValue(double)

setArrowBorderColor

public void setArrowBorderColor(java.awt.Color arrowBorderColor)

Sets the color of a vector's arrow border. Default color is black.

Parameters:

arrowBorderColor - A Color object.

setArrowBorderEnabled

public void setArrowBorderEnabled(boolean isArrowBorderEnabled)

Enables/disables a border surrounding a vector's arrow. The border is disabled by default.

Parameters:

isArrowBorderEnabled - A boolean value(true/false).

See Also:

setArrowBorderColor(java.awt.Color)

setBaseLineEnabled

public void setBaseLineEnabled(boolean isBaseLineEnabled)

Enables/disables the base line of a vector series. The base line is disabled by default.

Parameters:

isBaseLineEnabled - A boolean value(true/false).

See Also:

setBaseLineValue(double)

setLength

public void setLength(int length)

Sets the length of a vector's line. Default value is 30 pixels.

Parameters:

length - An integer value, greater than 1.

setArrowWidth

public void setArrowWidth(int arrowWidth)

Sets the width of a vector's arrow. Default value is 10 pixels.

Parameters:

arrowWidth - An integer value, greater than 1.

setArrowLength

public void setArrowLength(int arrowLength)

Sets the length of a vector's arrow. Default value is 10 pixels.

Parameters:

arrowLength - An integer value, greater than 1.

setArrowStyle

public void setArrowStyle(int arrowStyle)

Sets the arrow style. Default value is SOLID.

Parameters:

arrowStyle - An integer number.

See Also:

SOLID, EMPTY

setCardinalPointsEnabled

public void setCardinalPointsEnabled(boolean isCardinalPointsEnabled)

Enables/disables data reading as the cardinal points of a wind rose. If enabled, each vector value(degrees) is measured clockwise, with the 0, 90, 180, 270 and 360 degrees corresponding to the North, East, South, West and North cardinal points of a wind rose, respectively.
Cardinal points reading is disabled by default.

Parameters:

isCardinalPointsEnabled - A boolean value(true/false).

See Also:

VectorSerie(double[]), VectorSerie(double[],String)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class GraphSerie

Throws:

java.lang.Throwable