com.steema.teechart.styles
Class Arrow

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Series
          com.steema.teechart.styles.CustomPoint
              com.steema.teechart.styles.Points
                  com.steema.teechart.styles.Arrow

All Implemented Interfaces:

ISeries, java.io.Serializable, java.lang.Cloneable

public class Arrow
extends Points

Title: Arrow class

Description: Arrow Series.

Copyright (c) 2005-2006 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.steema.teechart.styles.Series

Series.MarkTextResolver

Field Summary

protected ChartPen

linePen

Fields inherited from class com.steema.teechart.styles.CustomPoint

iStacked, point

Fields inherited from class com.steema.teechart.styles.Series

AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, InternalUse, iNumSampleValues, iZOrder, labelMember, lastVisible, listenerList, mandatory, manualData, marks, middleZ, notMandatory, percentDecimal, percentFormat, sLabels, startZ, useAxis, useSeriesColor, valueFormat, vxValues, vyValues, yMandatory

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Arrow()

Arrow(IBaseChart c)

Method Summary

int	add(double x0, double y0, double x1, double y1) Adds an Arrow with start and end coordinates.
int	add(double x0, double y0, double x1, double y1, Color color) Returns the position of the Arrow in the list.
int	add(double x0, double y0, double x1, double y1, java.lang.String text) Adds an Arrow with start and end coordinates and label.
int	add(double x0, double y0, double x1, double y1, java.lang.String text, Color color) Returns the position of the Arrow in the list.
protected void	addSampleValues(int numValues)
int	clicked(int x, int y) Returns the ValueIndex of the "clicked" point in the Series.
void	drawValue(int valueIndex) Called internally.
int	getArrowHeight() Determines the vertical arrow head size in pixels.
int	getArrowWidth() Determines the horizontal arrow head size in pixels.
java.lang.String	getDescription() Gets descriptive text.
ValueList	getEndXValues() The X1 values for Arrows.
ValueList	getEndYValues() The Y1 values for Arrows.
double	getMaxXValue() The Maximum Value of the Series X Values List.
double	getMaxYValue() The Maximum Value of the Series Y Values List.
double	getMinXValue() The Minimum Value of the Series X Values List.
double	getMinYValue() The Minimum Value of the Series Y Values List.
ValueList	getStartXValues() The X0 values for Arrows.
ValueList	getStartYValues() The Y0 values for Arrows.
void	setArrowHeight(int value) Sets the vertical arrow head size in pixels.
void	setArrowWidth(int value) Sets the horizontal arrow head size in pixels.
void	setEndXValues(ValueList value) Sets X1 values for Arrows.
void	setEndYValues(ValueList value) Sets Y1 values for Arrows.
void	setStartXValues(ValueList value) Sets X0 values for Arrows.
void	setStartYValues(ValueList value) Sets Y0 values for Arrows.

Methods inherited from class com.steema.teechart.styles.Points

canDoExtra, createSubGallery, getColor, getLinePen, setColor, setColorEach, setSubGallery

Methods inherited from class com.steema.teechart.styles.CustomPoint

addSeriesMouseListener, assign, calcHorizMargins, calcVerticalMargins, calcXPos, calcYPos, calcZOrder, clickedPointer, drawLegendShape, drawMark, drawPointer, getOriginPos, getPointer, getStacked, onGetPointerStyle, removePointerStyleResolver, removeSeriesMouseListener, setChart, setPointerStyleResolver, setStacked

Methods inherited from class com.steema.teechart.styles.Series

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addChartValue, added, addNull, addNullXY, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcPosValue, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawLegend, drawLegend, drawMarks, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMarks, getMarkText, getMarkValue, getMaxZValue, getMiddleZ, getMinZValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getPoint, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueColor, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isValidSeriesSource, isValidSourceOf, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, numSampleValues, onDisposing, paintLegend, prepareForGallery, prepareLegendCanvas, randomBounds, readResolve, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valuesListAdd, xScreenToValue, yScreenToValue

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.steema.teechart.styles.ISeries

getChart, invalidate

Field Detail

linePen

protected ChartPen linePen

Constructor Detail

Arrow

public Arrow()

Arrow

public Arrow(IBaseChart c)

Method Detail

getArrowHeight

public int getArrowHeight()

Determines the vertical arrow head size in pixels.
It sets the distance from the base of the arrow head to the arrow tip in pixels. It can be used together with ArrowWidth to determine the overall size of the arrow head.

Returns:

int

setArrowHeight

public void setArrowHeight(int value)

Sets the vertical arrow head size in pixels.

Parameters:

value - int

See Also:

getArrowHeight()

getArrowWidth

public int getArrowWidth()

Determines the horizontal arrow head size in pixels.
Default value: 4

Returns:

int

setArrowWidth

public void setArrowWidth(int value)

Sets the horizontal arrow head size in pixels.
Default value: 4

Parameters:

value - int

getStartXValues

public ValueList getStartXValues()

The X0 values for Arrows.
Each Arrow has (X0,Y0) and (X1,Y1) coordinates.
StartXValues.DateTime property default value is true.

Returns:

ValueList

setStartXValues

public void setStartXValues(ValueList value)

Sets X0 values for Arrows.

Parameters:

value - ValueList

getStartYValues

public ValueList getStartYValues()

The Y0 values for Arrows.
Each Arrow has (X0,Y0) and (X1,Y1) coordinates.

Returns:

ValueList

setStartYValues

public void setStartYValues(ValueList value)

Sets Y0 values for Arrows.

Parameters:

value - ValueList

getEndXValues

public ValueList getEndXValues()

The X1 values for Arrows.
Each Arrow has (X0,Y0) and (X1,Y1) coordinates.

Returns:

ValueList

setEndXValues

public void setEndXValues(ValueList value)

Sets X1 values for Arrows.

Parameters:

value - ValueList

getEndYValues

public ValueList getEndYValues()

The Y1 values for Arrows.
Each Arrow has (X0,Y0) and (X1,Y1) coordinates.

Returns:

ValueList

setEndYValues

public void setEndYValues(ValueList value)

Sets Y1 values for Arrows.

Parameters:

value - ValueList

add

public int add(double x0,
               double y0,
               double x1,
               double y1)

Adds an Arrow with start and end coordinates.
Returns the position of the Arrow in the list.
Positions start at zero.

Each arrow is made of 2 points:
(X0,Y0) The starting arrow point.
(X1,Y1) The arrow head end point.

Parameters:

x0 - double arrow start x coordinate

y0 - double arrow start y coordinate

x1 - double arrow end x coordinate

y1 - double arrow end y coordinate

Returns:

int

add

public int add(double x0,
               double y0,
               double x1,
               double y1,
               java.lang.String text)

Adds an Arrow with start and end coordinates and label.
Returns the position of the Arrow in the list.
Positions start at zero.

Each arrow is made of 2 points:
(X0,Y0) The starting arrow point.
(X1,Y1) The arrow head end point.
Label (overload option)

Parameters:

x0 - double arrow start x coordinate

y0 - double arrow start y coordinate

x1 - double arrow end x coordinate

y1 - double arrow end y coordinate

text - String label text

Returns:

int

add

public int add(double x0,
               double y0,
               double x1,
               double y1,
               Color color)

Returns the position of the Arrow in the list.
Positions start at zero.

Each arrow is made of 2 points:
(X0,Y0) The starting arrow point.
(X1,Y1) The arrow head end point.
Color (overload option)

Parameters:

x0 - double arrow start x coordinate

y0 - double arrow start y coordinate

x1 - double arrow end x coordinate

y1 - double arrow end y coordinate

color - Color arrow color

Returns:

int

add

public int add(double x0,
               double y0,
               double x1,
               double y1,
               java.lang.String text,
               Color color)

Returns the position of the Arrow in the list.
Positions start at zero.

Each arrow is made of 2 points:
(X0,Y0) The starting arrow point.
(X1,Y1) The arrow head end point.
Label (overload option)
Color (overload option)

Parameters:

x0 - double arrow start x coordinate

y0 - double arrow start y coordinate

x1 - double arrow end x coordinate

y1 - double arrow end y coordinate

text - String label text

color - Color arrow color

Returns:

int

addSampleValues

protected void addSampleValues(int numValues)

Overrides:

addSampleValues in class Series

clicked

public int clicked(int x,
                   int y)

Description copied from class: CustomPoint

Returns the ValueIndex of the "clicked" point in the Series.

Specified by:

clicked in interface ISeries

Overrides:

clicked in class CustomPoint

Parameters:

x - int

y - int

Returns:

int

getMaxXValue

public double getMaxXValue()

The Maximum Value of the Series X Values List.

Overrides:

getMaxXValue in class CustomPoint

Returns:

double

getMinXValue

public double getMinXValue()

The Minimum Value of the Series X Values List.

Overrides:

getMinXValue in class CustomPoint

Returns:

double

getMaxYValue

public double getMaxYValue()

The Maximum Value of the Series Y Values List.

Overrides:

getMaxYValue in class CustomPoint

Returns:

double

getMinYValue

public double getMinYValue()

The Minimum Value of the Series Y Values List.

Overrides:

getMinYValue in class CustomPoint

Returns:

double

drawValue

public void drawValue(int valueIndex)

Called internally. Draws the "ValueIndex" point of the Series.

Specified by:

drawValue in interface ISeries

Overrides:

drawValue in class CustomPoint

Parameters:

valueIndex - int

getDescription

public java.lang.String getDescription()

Gets descriptive text.

Overrides:

getDescription in class Points

Returns:

String