com.steema.teechart.styles
Class Bar3D

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.CustomBar
              extended by com.steema.teechart.styles.Bar
                  extended by com.steema.teechart.styles.Bar3D
All Implemented Interfaces:
ISeries

public class Bar3D
extends Bar

Title: Bar3D class

Description: Bar3D series.

Example:


 series1 = new Bar3D(myChart.getChart());
 series1.add( 0, 250, 200, "A", Color.RED );
 series1.add( 1,  10, 200, "B", Color.GREEN );
 series1.add( 2,  90, 100, "C", Color.YELLOW );
 series1.add( 3,  30,  50, "D", Color.BLUE );
 series1.add( 4,  70, 150, "E", Color.WHITE );
 series1.add( 5, 120, 150, "F", Color.SILVER );
 series1.setColorEach(true);
 series1.getMarks().setArrowLength(20);
 series1.getMarks().setVisible(true);
 series1.setBarStyle(BarStyle.RECTGRADIENT);
 series1.setBarWidthPercent(90);
 series1.getGradient().setDirection(GradientDirection.HORIZONTAL);
 series1.getGradient().setStartColor(Color.YELLOW);
 

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.CustomBar
CustomBar.BarStyleResolver
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
 
Fields inherited from class com.steema.teechart.styles.CustomBar
barSizePercent, bDark3D, bUseOrigin, conePercent, customBarSize, dOrigin, iBarBounds, iBarSize, iMultiBar, iNumBars, iOrderPos, iPreviousCount, marksOnBar, normalBarColor, pPen
 
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
Bar3D()
           
Bar3D(IBaseChart c)
           
 
Method Summary
 int add(double x, double y, double offset)
          Adds a bar with an X and Y value and Y start point.
 int add(double x, double y, double offset, Color color)
          Adds a bar with an X and Y value, Y start point and color.
 int add(double x, double y, double offset, java.lang.String text)
          Adds a bar with an X and Y value with offset and label.
 int add(double x, double y, double offset, java.lang.String text, Color color)
          Adds a bar with an X and Y value, Y start point, label and color.
protected  void addSampleValues(int numValues)
           
 java.lang.String getDescription()
          Gets descriptive text.
 double getMaxYValue()
          Returns the Maximum Value of the Series Y Values List.
 double getMinYValue()
          Returns the Minimum Value of the Series Y Values List.
 ValueList getOffsetValues()
          Specifies a different origin value for each bar point.
 double getOriginValue(int valueIndex)
           
 double pointOrigin(int valueIndex, boolean sumAll)
          Returns the corresponding screen pixels coordinate of the leftmost horizontal bar edge.
 void setOffsetValues(ValueList value)
          Specifies a different origin value for each bar point.
protected  boolean subGalleryStack()
           
 
Methods inherited from class com.steema.teechart.styles.Bar
calcBarBounds, calcHorizMargins, calcVerticalMargins, calcXPos, calcYPos, drawBar, drawMark, drawMarks, drawTickLine, drawValue, getBarWidthPercent, getMaxXValue, getMinXValue, getOriginPos, internalCalcMarkLength, internalClicked, moreSameZOrder, setBarWidthPercent
 
Methods inherited from class com.steema.teechart.styles.CustomBar
applyBarOffset, barMargin, barRectangle, barRectangle, calcFirstLastVisibleIndex, calcFirstLastVisibleIndex, calcMarkLength, calcZOrder, clicked, createSubGallery, doBarGradient, doBeforeDrawChart, doGetBarStyle, doGradient3D, drawLegendShape, drawTickLines, drawValuesForward, getAutoMarkPosition, getBarBounds, getBarBoundsMidX, getBarStyle, getBrush, getConePercent, getCustomBarWidth, getDark3D, getDepthPercent, getGradient, getGradientRelative, getMarksLocation, getMarksOnBar, getMultiBar, getOffsetPercent, getOrigin, getPen, getSideMargins, getStackGroup, getTickLines, getUseOrigin, getYOrigin, internalApplyBarMargin, internalGetOriginPos, isPointInChartRect, lastVisibleMark, maxMandatoryValue, minMandatoryValue, numSampleValues, prepareForGallery, removeBarStyleResolver, setAutoMarkPosition, setBarSizePercent, setBarStyle, setBarStyleResolver, setChart, setConePercent, setCustomBarWidth, setDark3D, setDepthPercent, setGradientRelative, setMarksLocation, setMarksOnBar, setMultiBar, setOffsetPercent, setOrigin, setPenBrushBar, setSideMargins, setStackGroup, setSubGallery, setUseOrigin, setYOrigin, setZPositions, shouldSerializeYOrigin
 
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, addValues, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcPercentSt, calcPosValue, calculateMarkPosition, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, countLegendItems, createNewSeries, createNewSeries, createNewSeries, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, draw, drawHiddenValue, drawLegend, drawLegend, drawMarksSeries, drawSeries, drawSeriesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, firstDisplayed, galleryChanged3D, getActive, getAllowSinglePoint, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDefaultColor, getDefaultNullValue, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMandatoryAxis, getMarks, getMarkText, getMarkValue, getMaxZValue, getMiddleZ, getMinZValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, 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, isValidSeriesSource, isValidSourceOf, lastDisplayed, legendItemColor, legendToValueIndex, maxMarkWidth, mouseEvent, newFromType, onDisposing, prepareLegendCanvas, randomBounds, readResolve, 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, 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
 

Constructor Detail

Bar3D

public Bar3D()

Bar3D

public Bar3D(IBaseChart c)
Method Detail

addSampleValues

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

add

public int add(double x,
               double y,
               double offset,
               Color color)
Adds a bar with an X and Y value, Y start point and color.

Parameters:
x - double
y - double
offset - double
color - Color
Returns:
int

add

public int add(double x,
               double y,
               double offset)
Adds a bar with an X and Y value and Y start point.

Parameters:
x - double
y - double
offset - double
Returns:
int

add

public int add(double x,
               double y,
               double offset,
               java.lang.String text)
Adds a bar with an X and Y value with offset and label.

Parameters:
x - double
y - double
offset - double
text - String
Returns:
int

add

public int add(double x,
               double y,
               double offset,
               java.lang.String text,
               Color color)
Adds a bar with an X and Y value, Y start point, label and color.

Parameters:
x - double
y - double
offset - double
text - String
color - Color
Returns:
int

getOriginValue

public double getOriginValue(int valueIndex)
Specified by:
getOriginValue in interface ISeries
Overrides:
getOriginValue in class Series

getMaxYValue

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

Overrides:
getMaxYValue in class Bar
Returns:
double

getMinYValue

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

Overrides:
getMinYValue in class Bar
Returns:
double

pointOrigin

public double pointOrigin(int valueIndex,
                          boolean sumAll)
Returns the corresponding screen pixels coordinate of the leftmost horizontal bar edge.
The UseOrigin property must be true (the default) to use the Origin method.
Bars with a value bigger than Origin are drawn in one direction and Bars with a lower value are drawn in the opposite direction.
This applies both to Bar series and HorizBar series classes.
Default Value: 0

Overrides:
pointOrigin in class CustomBar
Parameters:
valueIndex - int
sumAll - boolean
Returns:
double

getOffsetValues

public ValueList getOffsetValues()
Specifies a different origin value for each bar point.
This can be used with standard Bar series components to make a "Stacked-3D" chart type.

Returns:
ValueList

setOffsetValues

public void setOffsetValues(ValueList value)
Specifies a different origin value for each bar point.
This can be used with standard Bar series components to make a "Stacked-3D" chart type.

Parameters:
value - ValueList

getDescription

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

Overrides:
getDescription in class Bar
Returns:
String

subGalleryStack

protected boolean subGalleryStack()
Overrides:
subGalleryStack in class CustomBar