com.steema.teechart.styles
Class Tower

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.Tower
All Implemented Interfaces:
ISeries

public class Tower
extends Custom3DGrid

Title: Tower class

Description: Tower Series. The Tower Series is designed to use a 0 or 1 based integer grid index.
X and Z values should be sequential values of 1.

Example:


 series = new Tower(myChart.getChart());
 series.setOrigin(500.0);
 series.setUseOrigin(true);
 series.setPaletteStyle(PaletteStyle.STRONG);
 series.setUseColorRange(false);
 series.setUsePalette(true);
 series.fillSampleValues();
 

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.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
 
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
Tower()
           
Tower(IBaseChart c)
           
 
Method Summary
 void createSubGallery(Gallery addSubChart)
           
protected  void draw()
           
protected  void drawMark(int valueIndex, java.lang.String s, SeriesMarksPosition position)
           
 boolean getDark3D()
          When true, draws right and top sides of cubes using a darker color.
 java.lang.String getDescription()
          Gets descriptive text.
 double getMaxXValue()
          The Maximum Value of the Series X Values List.
 double getMaxZValue()
          The biggest value in the Series ZValues array.
 double getMinXValue()
          The Minimum Value of the Series X Values List.
 double getMinZValue()
          The lowest value in the Series ZValues array.
 double getOrigin()
          The axis vertical position considered to be the "origin" of points.
 int getPercentDepth()
          The percentage of "Z" depth size for tower cubes.
 int getPercentWidth()
          The percentage of "X" width size for tower cubes.
 TowerStyle getTowerStyle()
          The kind of tower style to display.
 int getTransparency()
          The Transparency level from 0 to 100%.
 boolean getUseOrigin()
          When true, Origin is used as the reference value where points are considered positive or negative.
 void prepareForGallery(boolean isEnabled)
           
 void setDark3D(boolean value)
          When true, draws right and top sides of cubes using a darker color.
 void setOrigin(double value)
          The axis vertical position considered to be the "origin" of points.
 void setPercentDepth(int value)
          The percentage of "Z" depth size for tower cubes.
 void setPercentWidth(int value)
          The percentage of "X" width size for tower cubes.
 void setSubGallery(int index)
          Creates and prepares the index'th Series style to show at sub-gallery dialog.
 void setTowerStyle(TowerStyle value)
          Determines the kind of tower style to display.
 void setTransparency(int value)
          Sets Transparency level from 0 to 100%.
 void setUseOrigin(boolean value)
          When true, Origin is used as the reference value where points are considered positive or negative.
 
Methods inherited from class com.steema.teechart.styles.Custom3DGrid
addSampleValues, addValues, backFaced, canCreateValues, clear, createValues, doBeforeDrawChart, 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, getCountLegendItems, getEndColor, getGreenFactor, getLegendString, getMidColor, getPalette, getPaletteMin, getPaletteRange, getPaletteStep, getPaletteSteps, getPaletteStyle, getPen, getRedFactor, getStartColor, getUseColorRange, getUsePalette, getUsePaletteMin, getValueColor, getValueColorValue, legendItemColor, readResolve, 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, 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, drawMarks, 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, getMaxYValue, getMiddleZ, getMinYValue, 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
 

Constructor Detail

Tower

public Tower()

Tower

public Tower(IBaseChart c)
Method Detail

getDark3D

public boolean getDark3D()
When true, draws right and top sides of cubes using a darker color.
Default value: true

Returns:
boolean

setDark3D

public void setDark3D(boolean value)
When true, draws right and top sides of cubes using a darker color.
Default value: true

Parameters:
value - boolean

getPercentDepth

public int getPercentDepth()
The percentage of "Z" depth size for tower cubes.
Default value: 100

Returns:
int

setPercentDepth

public void setPercentDepth(int value)
The percentage of "Z" depth size for tower cubes.
Default value: 100

Parameters:
value - int

getPercentWidth

public int getPercentWidth()
The percentage of "X" width size for tower cubes.
Default value: 100

Returns:
int

setPercentWidth

public void setPercentWidth(int value)
The percentage of "X" width size for tower cubes.
Default value: 100

Parameters:
value - int

getTowerStyle

public TowerStyle getTowerStyle()
The kind of tower style to display.
Available styles: Cube, Rectangle, Cover, Cylinder, Arrow, Cone and Pyramid .
Default value: Cube

Returns:
TowerStyle

setTowerStyle

public void setTowerStyle(TowerStyle value)
Determines the kind of tower style to display.
Default value: Cube

Parameters:
value - TowerStyle

getOrigin

public double getOrigin()
The axis vertical position considered to be the "origin" of points.
Points with values below origin are considered "negatives".
By default, Origin is not used. Instead, the lowest Y value of the series is considered to be the origin.

Returns:
double
See Also:
getUseOrigin()

setOrigin

public void setOrigin(double value)
The axis vertical position considered to be the "origin" of points.

Parameters:
value - double
See Also:
getUseOrigin()

getUseOrigin

public boolean getUseOrigin()
When true, Origin is used as the reference value where points are considered positive or negative.
When false, the lowest Y value of the series is the reference value (no points are negative).
Default value: false

Returns:
boolean

setUseOrigin

public void setUseOrigin(boolean value)
When true, Origin is used as the reference value where points are considered positive or negative.
When false, the lowest Y value of the series is the reference value (no points are negative).
Default value: false

Parameters:
value - boolean

getTransparency

public int getTransparency()
The Transparency level from 0 to 100%.
Default value: 0

Returns:
int

setTransparency

public void setTransparency(int value)
Sets Transparency level from 0 to 100%.
Default value: 0

Parameters:
value - int

createSubGallery

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

drawMark

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

prepareForGallery

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

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

getMaxXValue

public double getMaxXValue()
The Maximum Value of the Series X Values List.

Overrides:
getMaxXValue in class Series
Returns:
double

getMaxZValue

public double getMaxZValue()
The biggest value in the Series ZValues array.

Specified by:
getMaxZValue in interface ISeries
Overrides:
getMaxZValue in class Custom3D
Returns:
double

getMinXValue

public double getMinXValue()
The Minimum Value of the Series X Values List.

Overrides:
getMinXValue in class Series
Returns:
double

getMinZValue

public double getMinZValue()
The lowest value in the Series ZValues array.

Specified by:
getMinZValue in interface ISeries
Overrides:
getMinZValue in class Custom3D
Returns:
double

draw

protected void draw()
Overrides:
draw in class Series

getDescription

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

Overrides:
getDescription in class Series
Returns:
String