com.steema.teechart.styles
Class PointFigure

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.CustomPoint
              extended by com.steema.teechart.styles.Custom
                  extended by com.steema.teechart.styles.OHLC
                      extended by com.steema.teechart.styles.PointFigure
All Implemented Interfaces:
ISeries

public class PointFigure
extends OHLC

Title: PointFigure class

Description: PointFigure Series.

Example:


 series1 = new com.steema.teechart.styles.PointFigure(myChart.getChart());
 series1.fillSampleValues();
 series1.setBoxSize(5);
 series1.getMarks().setVisible(false);
 

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

Company: Steema Software SL


Nested Class Summary
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
protected  ChartPen linePen
           
protected  boolean treatNans
           
protected  TreatNullsStyle treatnulls
           
 
Fields inherited from class com.steema.teechart.styles.OHLC
vHighValues, vLowValues, vOpenValues
 
Fields inherited from class com.steema.teechart.styles.Custom
bAreaBrush, bClickableLine, bDark3D, drawArea, drawLine, pAreaLines
 
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, 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, InternalUse
 
Constructor Summary
PointFigure()
           
PointFigure(IBaseChart c)
           
 
Method Summary
 void add(double[] xValues, double[] yValues, boolean append)
           
 int add(double x, double y)
          Adds a new point with specified x and y values.
protected  void addSampleValues(int numValues)
           
protected  boolean doNotPaintNull()
           
protected  void draw()
           
 double getBoxSize()
          Determines the amount in price scales that is multiplied by ReversalAmount.
 int getCountLegendItems()
           
 java.lang.String getDescription()
          Gets descriptive text.
 SeriesPointer getDownSymbol()
           
 java.lang.String getLegendString(int legendIndex, LegendTextStyle legendTextStyle)
          Returns the formatted String corresponding to the LegendIndex point.
 ChartPen getLinePen()
          Determines pen to draw the line connecting all points.
 double getMaxXValue()
          Returns the Maximum Value of the Series X Values List.
 double getMinXValue()
          Returns the Minimum Value of the Series X Values List.
 double getReversalAmount()
          The number that is multiplied by BoxSize.
 boolean getTreatNaNAsNull()
           
 TreatNullsStyle getTreatNulls()
          Defines how null points are treated.
 SeriesPointer getUpSymbol()
           
protected  boolean IgnoreNull()
           
 Color legendItemColor(int index)
           
 void prepareForGallery(boolean isEnabled)
           
 void setBoxSize(double value)
          Determines the amount in price scales that is multiplied by ReversalAmount.
 void setChart(IBaseChart value)
          Chart associated with this object.
 void setReversalAmount(double value)
          Determines the number that is multiplied by BoxSize.
 void setTreatNaNAsNull(boolean value)
           
 void setTreatNulls(TreatNullsStyle value)
           
 
Methods inherited from class com.steema.teechart.styles.OHLC
add, add, add, add, calcMinMaxValue, getCloseValues, getDateValues, getHighValues, getLowValues, getMaxYValue, getMinYValue, getOHLCPoint, getOpenValues, isValidSourceOf, numSampleValues, setCloseValues, setDateValues, setHighValues, setLowValues, setOpenValues
 
Methods inherited from class com.steema.teechart.styles.Custom
assign, calcHorizMargins, calcVerticalMargins, clicked, drawHiddenValue, drawLegendShape, drawValue, getAreaBrushColor, getBrush, getClickableLine, getColorEachLine, getDark3D, getInvertedStairs, getLineHeight, getOpacity, getOutLine, getSmoothed, getStairs, getTransparency, readResolve, setClickableLine, setColor, setColorEachLine, setDark3D, setInvertedStairs, setLineHeight, setOpacity, setSmoothed, setStairs, setTransparency
 
Methods inherited from class com.steema.teechart.styles.CustomPoint
addSeriesMouseListener, calcXPos, calcYPos, calcZOrder, clickedPointer, drawMark, drawPointer, getOriginPos, getPointer, getStacked, onGetPointerStyle, removePointerStyleResolver, removeSeriesMouseListener, sameClassOrigin, 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, addedValue, addNull, addNullXY, addSeriesPaintListener, addValues, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcPercentSt, calcPosValue, calculateMarkPosition, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawLegend, drawLegend, drawMarks, drawMarksSeries, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getColor, getColorEach, getColorMember, getColors, getCount, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getMandatory, getMandatoryAxis, 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, hasClickEvents, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isPointInChartRect, isValidSeriesSource, isValidSourceOf, lastDisplayed, lastVisibleMark, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, onDisposing, prepareLegendCanvas, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDefaultNullValue, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setSubGallery, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valueListOfAxis, valuesListAdd, xScreenToValue, yScreenToValue
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, 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

treatnulls

protected TreatNullsStyle treatnulls

treatNans

protected boolean treatNans
Constructor Detail

PointFigure

public PointFigure()

PointFigure

public PointFigure(IBaseChart c)
Method Detail

getBoxSize

public double getBoxSize()
Determines the amount in price scales that is multiplied by ReversalAmount.
ReversalAmount by BoxSize defines the maximum price difference allowed before adding a new column of symbols.
BoxSize itself defines the minimum change in price to draw a new symbol in the same column.
Default value: 1

Returns:
double

setBoxSize

public void setBoxSize(double value)
Determines the amount in price scales that is multiplied by ReversalAmount.
Default value: 1

Example:


 series1.setBoxSize(5);
 

Parameters:
value - double

getReversalAmount

public double getReversalAmount()
The number that is multiplied by BoxSize.
ReversalAmount by BoxSize defines the maximum price difference allowed before adding a new column of symbols.
Default value: 3

Returns:
double

setReversalAmount

public void setReversalAmount(double value)
Determines the number that is multiplied by BoxSize.
Default value: 3

Parameters:
value - double

addSampleValues

protected void addSampleValues(int numValues)
Overrides:
addSampleValues in class OHLC

draw

protected void draw()
Overrides:
draw in class Custom

prepareForGallery

public void prepareForGallery(boolean isEnabled)
Overrides:
prepareForGallery in class Series

setChart

public void setChart(IBaseChart value)
Description copied from class: TeeBase
Chart associated with this object.

Specified by:
setChart in interface ISeries
Overrides:
setChart in class Custom
Parameters:
value - IBaseChart

getCountLegendItems

public int getCountLegendItems()
Specified by:
getCountLegendItems in interface ISeries
Overrides:
getCountLegendItems in class Series

legendItemColor

public Color legendItemColor(int index)
Specified by:
legendItemColor in interface ISeries
Overrides:
legendItemColor in class Series

getLegendString

public java.lang.String getLegendString(int legendIndex,
                                        LegendTextStyle legendTextStyle)
Description copied from class: Series
Returns the formatted String corresponding to the LegendIndex point.

Specified by:
getLegendString in interface ISeries
Overrides:
getLegendString in class Series
Parameters:
legendIndex - int
legendTextStyle - LegendTextStyle
Returns:
String

getMaxXValue

public double getMaxXValue()
Description copied from class: CustomPoint
Returns the Maximum Value of the Series X Values List.

Overrides:
getMaxXValue in class CustomPoint
Returns:
double

getMinXValue

public double getMinXValue()
Description copied from class: CustomPoint
Returns the Minimum Value of the Series X Values List.

Overrides:
getMinXValue in class CustomPoint
Returns:
double

getDownSymbol

public SeriesPointer getDownSymbol()

getUpSymbol

public SeriesPointer getUpSymbol()

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Series
Returns:
String

getLinePen

public ChartPen getLinePen()
Determines pen to draw the line connecting all points.

Returns:
ChartPen

getTreatNulls

public TreatNullsStyle getTreatNulls()
Defines how null points are treated.

Returns:
TreatNullsStyle

setTreatNulls

public void setTreatNulls(TreatNullsStyle value)

add

public void add(double[] xValues,
                double[] yValues,
                boolean append)
Overrides:
add in class Series

add

public int add(double x,
               double y)
Description copied from class: Series
Adds a new point with specified x and y values.

Specified by:
add in interface ISeries
Overrides:
add in class Series
Parameters:
x - double
y - double
Returns:
int

IgnoreNull

protected boolean IgnoreNull()

doNotPaintNull

protected boolean doNotPaintNull()

getTreatNaNAsNull

public boolean getTreatNaNAsNull()

setTreatNaNAsNull

public void setTreatNaNAsNull(boolean value)