com.steema.teechart.styles
Class Contour

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.Custom3D
              extended by com.steema.teechart.styles.Custom3DPalette
                  extended by com.steema.teechart.styles.Custom3DGrid
                      extended by com.steema.teechart.styles.Contour
All Implemented Interfaces:
ISeries

public class Contour
extends Custom3DGrid

Title: Contour class

Description: The Contour series calculates and displays "isolines" from a custom array of XYZ points.

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

Company: Steema Software SL


Nested Class Summary
 class Contour.ContourDraw
          Title: ContourDraw class Description: Composite of the Contour series class.
 class Contour.LevelProps
           
static interface Contour.LevelResolver
           
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Custom3DGrid
Custom3DGrid.CellsRow, Custom3DGrid.PCellsRow, Custom3DGrid.YCalculator
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Custom3DPalette
Custom3DPalette.ColorResolver
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
protected  boolean iModifyingLevels
           
protected  Contour.LevelResolver levelResolver
           
 Color LinesColor
           
 
Fields inherited from class com.steema.teechart.styles.Custom3DGrid
FXStartIndex, FZStartIndex, gridIndex, iInGallery, iNextXCell, iNextZCell, iNumXValues, iNumZValues, valueIndex0, valueIndex1, valueIndex2, valueIndex3
 
Fields inherited from class com.steema.teechart.styles.Custom3DPalette
bUseColorRange, bUsePalette, iPaletteSteps, sameBrush
 
Fields inherited from class com.steema.teechart.styles.Custom3D
vzValues
 
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
Contour()
           
Contour(IBaseChart c)
           
 
Method Summary
protected  void addSampleValues(int numValues)
           
 void createAutoLevels()
           
 void createSubGallery(Gallery addSubChart)
           
 void doBeforeDrawChart()
           
protected  void draw()
           
protected  void drawMark(int valueIndex, java.lang.String s, SeriesMarksPosition position)
           
 void drawMarks()
           
 boolean getAutomaticLevels()
          The ContourSeries Automatic Levels.
 ContourSeriesMarks getContourMarks()
           
 int getCountLegendItems()
           
 java.lang.String getDescription()
          Gets descriptive text.
 ContourConstruction getDrawingalgorithm()
           
 boolean getFillLevels()
          The ContourSeries FillLevels.
 ChartPen getFrame()
           
 java.lang.String getLegendString(int legendIndex, LegendTextStyle legendTextStyle)
          Returns LegendString for LegendIndexth item.
 ContourLevels getLevels()
          Accesses ContourLevel characteristics by selecting Level index.
 double getMaxYValue()
          The Maximum Value of the Series Y Values List.
 double getMinYValue()
          The Minimum Value of the Series Y Values List.
 int getNumLevels()
          The number of 'isobar-like' levels for the ContourSeries.
 SeriesPointer getPointer()
           
 double getYPosition()
          Sets the Y-Axis height of the Contour Series.
 boolean getYPositionLevel()
          Enables/disables YPosition to be set.
 Axis getZAxis()
           
protected  java.lang.Object readResolve()
           
 void removeContourLevelResolver()
           
 void setAutomaticLevels(boolean value)
          Sets ContourSeries Automatic Levels.
 void setContourLevelResolver(Contour.LevelResolver resolver)
           
 void setContourMarks(ContourSeriesMarks value)
           
 void setDrawingalgorithm(ContourConstruction value)
           
 void setFillLevels(boolean value)
          Sets ContourSeries FillLevels.
 void setLevels(ContourLevels value)
          Accesses ContourLevel characteristics by selecting Level index.
 void setNumLevels(int value)
          Sets the number of 'isobar-like' levels for the ContourSeries.
 void setSubGallery(int index)
          Creates and prepares the index'th Series style to show at sub-gallery dialog.
 void setYPosition(double value)
          Sets the Y-Axis height of the Contour Series.
 void setYPositionLevel(boolean value)
          Enables YPosition to be set when true.
 
Methods inherited from class com.steema.teechart.styles.Custom3DGrid
addValues, backFaced, canCreateValues, clear, createValues, doGetYValue, existFourGridIndex, fillGridIndex, getIndex, getIrregularGrid, getNumXValues, getNumZValues, isValidSeriesSource, numSampleValues, reCreateValues, removeYCalculator, setIndex, setIrregularGrid, setNumXValues, setNumZValues, setYCalculator
 
Methods inherited from class com.steema.teechart.styles.Custom3DPalette
addPalette, calcColorRange, clearPalette, countLegendItems, createDefaultPalette, drawLegendShape, galleryChanged3D, getBlueFactor, getBrush, getEndColor, getGreenFactor, getMidColor, getPalette, getPaletteMin, getPaletteRange, getPaletteStep, getPaletteSteps, getPaletteStyle, getPen, getRedFactor, getStartColor, getUseColorRange, getUsePalette, getUsePaletteMin, getValueColor, getValueColorValue, legendItemColor, prepareForGallery, removeColorResolver, setBlueFactor, setChart, setColorResolver, setEndColor, setGreenFactor, setMidColor, setPaletteMin, setPaletteRange, setPaletteStep, setPaletteSteps, setPaletteStyle, setRainbowPalette, setRedFactor, setSameBrush, setStartColor, setUseColorRange, setUsePalette, setUsePaletteMin
 
Methods inherited from class com.steema.teechart.styles.Custom3D
add, add, add, add, add, add, add, add, add, calcZOrder, calcZPos, getMaxZValue, getMinZValue, getPoint, getTimesZOrder, getZValues, isValidSourceOf, prepareLegendCanvas, setTimesZOrder, valueListOfAxis
 
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, add, add, addChartValue, added, addedValue, addNull, addNullXY, addSeriesMouseListener, addSeriesPaintListener, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPercentSt, calcPosValue, calculateMarkPosition, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clearLists, clicked, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawHiddenValue, drawLegend, drawLegend, drawMarksSeries, drawSeries, drawSeriesForward, drawValue, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, 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, getMaxXValue, getMiddleZ, getMinXValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasClickEvents, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isPointInChartRect, isValidSeriesSource, lastDisplayed, lastVisibleMark, legendToValueIndex, maxMarkWidth, moreSameZOrder, mouseEvent, newFromType, onDisposing, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesMouseListener, removeSeriesPaintListener, repaint, sameClass, setActive, setColor, 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, 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, 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

iModifyingLevels

protected transient boolean iModifyingLevels

LinesColor

public Color LinesColor

levelResolver

protected transient Contour.LevelResolver levelResolver
Constructor Detail

Contour

public Contour(IBaseChart c)

Contour

public Contour()
Method Detail

createSubGallery

public void createSubGallery(Gallery addSubChart)
Overrides:
createSubGallery in class Custom3DPalette

setContourLevelResolver

public void setContourLevelResolver(Contour.LevelResolver resolver)

removeContourLevelResolver

public void removeContourLevelResolver()

getFrame

public ChartPen getFrame()

getDescription

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

Overrides:
getDescription in class Series
Returns:
String

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class Custom3DPalette

getAutomaticLevels

public boolean getAutomaticLevels()
The ContourSeries Automatic Levels.
Default value: true

Returns:
boolean

setAutomaticLevels

public void setAutomaticLevels(boolean value)
Sets ContourSeries Automatic Levels.
Default value: true

Parameters:
value - boolean

getContourMarks

public ContourSeriesMarks getContourMarks()

setContourMarks

public void setContourMarks(ContourSeriesMarks value)

getFillLevels

public boolean getFillLevels()
The ContourSeries FillLevels.
Default value: false

Returns:
boolean

getPointer

public SeriesPointer getPointer()

setFillLevels

public void setFillLevels(boolean value)
Sets ContourSeries FillLevels.
Default value: false

Parameters:
value - boolean

getDrawingalgorithm

public ContourConstruction getDrawingalgorithm()

setDrawingalgorithm

public void setDrawingalgorithm(ContourConstruction value)

setSubGallery

public void setSubGallery(int index)
Description copied from class: Series
Creates and prepares the index'th Series style to show at sub-gallery dialog.

Specified by:
setSubGallery in interface ISeries
Overrides:
setSubGallery in class Custom3DPalette
Parameters:
index - int

getLegendString

public java.lang.String getLegendString(int legendIndex,
                                        LegendTextStyle legendTextStyle)
Description copied from class: Custom3DPalette
Returns LegendString for LegendIndexth item.

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

getLevels

public ContourLevels getLevels()
Accesses ContourLevel characteristics by selecting Level index.

Returns:
ContourLevels

setLevels

public void setLevels(ContourLevels value)
Accesses ContourLevel characteristics by selecting Level index.

Parameters:
value - ContourLevels

getNumLevels

public int getNumLevels()
The number of 'isobar-like' levels for the ContourSeries.
Default value: 10

Returns:
int

setNumLevels

public void setNumLevels(int value)
Sets the number of 'isobar-like' levels for the ContourSeries.
Default value: 10

Parameters:
value - int

getYPosition

public double getYPosition()
Sets the Y-Axis height of the Contour Series.
When YPositionLevel is set to true, use it to set the Y-Axis height of the Contour series.
This may be useful for adding several Contour series to a Chart and activating/deactivating layers.

Returns:
double

setYPosition

public void setYPosition(double value)
Sets the Y-Axis height of the Contour Series.

Parameters:
value - double

getYPositionLevel

public boolean getYPositionLevel()
Enables/disables YPosition to be set.
Default value: false

Returns:
boolean

getZAxis

public Axis getZAxis()

setYPositionLevel

public void setYPositionLevel(boolean value)
Enables YPosition to be set when true.
Default value: false

Parameters:
value - boolean

addSampleValues

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

getCountLegendItems

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

draw

protected void draw()
Overrides:
draw in class Series

drawMarks

public void drawMarks()
Specified by:
drawMarks in interface ISeries
Overrides:
drawMarks in class Series

drawMark

protected void drawMark(int valueIndex,
                        java.lang.String s,
                        SeriesMarksPosition position)
Overrides:
drawMark in class Custom3D

getMaxYValue

public double getMaxYValue()
The Maximum Value of the Series Y Values List.

Overrides:
getMaxYValue in class Series
Returns:
double

getMinYValue

public double getMinYValue()
The Minimum Value of the Series Y Values List.

Overrides:
getMinYValue in class Series
Returns:
double

doBeforeDrawChart

public void doBeforeDrawChart()
Overrides:
doBeforeDrawChart in class Custom3DGrid

createAutoLevels

public void createAutoLevels()