com.steema.teechart.styles
Class Area

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.styles.Series
          com.steema.teechart.styles.CustomPoint
              com.steema.teechart.styles.Custom
                  com.steema.teechart.styles.Area

All Implemented Interfaces:

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

Direct Known Subclasses:

HorizArea

public class Area
extends Custom

Title: Area class

Description: Area Series

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

Company: Steema Software SL

See Also:

TChart, 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.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, 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

Area()

Area(IBaseChart c)

Method Summary

void	createSubGallery(Gallery addSubChart)
ChartBrush	getAreaBrush() Determines the Brush used to fill the background Area region.
ChartPen	getAreaLines() Determines Pen to draw AreaLines.
ChartPen	getAreaLinesPen() Obsolete.
java.lang.String	getDescription() Gets descriptive text.
Gradient	getGradient() Determines Gradient to fill the background Area region.
ChartPen	getLinePen() Determines pen to draw the line connecting all points.
double	getMaxXValue() The Maximum Value of the Series X Values List.
double	getMaxYValue() Returns the highest of all the current Series Y point values.
double	getMinXValue() The Minimum Value of the Series X Values List.
double	getMinYValue() Returns the Minimum Value of the Series Y Values List.
MultiAreas	getMultiArea() Determines how Multi-AreaSeries are displayed.
double	getOrigin() The axis value as a common bottom for all AreaSeries points.
protected int	getOriginPos(int valueIndex)
Gradient	getTopGradient() Determines how to fill the top 3D Area region.
boolean	getUseOrigin() Aligns bottom of AreaSeries to the Origin property value.
protected void	prepareLegendCanvas(IGraphics3D g, int valueIndex, Color backColor, ChartBrush aBrush)
void	setMultiArea(MultiAreas value) Sets how multiple areas are displayed.
void	setOrigin(double value) Sets axis value as a common bottom for all AreaSeries points.
void	setSubGallery(int index) Creates and prepares the index'th Series style to show at sub-gallery dialog.
void	setUseOrigin(boolean value) Enables/disables the setting of the Y value (via the Origin property) that defines the bottom position for area points.

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

calcHorizMargins, calcVerticalMargins, clicked, draw, drawLegendShape, drawValue, getAreaBrushColor, getBrush, getClickableLine, getColorEachLine, getDark3D, getInvertedStairs, getLineHeight, getOpacity, getOutLine, getStairs, getTransparency, readResolve, setChart, setClickableLine, setColor, setColorEachLine, setDark3D, setInvertedStairs, setLineHeight, setOpacity, setStairs, setTransparency

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

addSeriesMouseListener, assign, calcXPos, calcYPos, calcZOrder, clickedPointer, drawMark, drawPointer, getPointer, getStacked, onGetPointerStyle, removePointerStyleResolver, removeSeriesMouseListener, 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, addSampleValues, 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, drawLegend, drawLegend, drawMarks, drawSeries, drawSeriesForward, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColor, 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, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesPaintListener, repaint, sameClass, setActive, setColorEach, 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

Area

public Area(IBaseChart c)

Area

public Area()

Method Detail

getMultiArea

public MultiAreas getMultiArea()

Determines how Multi-AreaSeries are displayed.
Determines the kind of displayed Area when there's more than one Area Series with the same ParentChart. The default value is None, meaning all Areas will be drawn one behind the other.
Stacked and Stacked100 modes will draw each Area on top of previous one.
Stacked100 adjusts each individual point to a common 0..100 axis scale.
The order which Series are accumulated depends on the Chart.SeriesList method.
Default value: None

Returns:

MultiAreas

See Also:

setMultiArea(com.steema.teechart.styles.MultiAreas)

setMultiArea

public void setMultiArea(MultiAreas value)

Sets how multiple areas are displayed.

Parameters:

value - MultiAreas

See Also:

getMultiArea()

getAreaBrush

public ChartBrush getAreaBrush()

Determines the Brush used to fill the background Area region.
You can control the Area background color by using the Series.Color method.
Default value: Solid

Returns:

ChartBrush

getTopGradient

public Gradient getTopGradient()

Determines how to fill the top 3D Area region.

Returns:

Gradient

getGradient

public Gradient getGradient()

Determines Gradient to fill the background Area region.

Returns:

Gradient

getAreaLinesPen

public ChartPen getAreaLinesPen()

Obsolete. Please use AreaLines instead.

Returns:

ChartPen

getAreaLines

public ChartPen getAreaLines()

Determines Pen to draw AreaLines.
By default AreaLines .Visible is false, so you need first to set it to true. You can control the Area Brush style by using AreaBrush.
Default value: null

Returns:

ChartPen

getUseOrigin

public boolean getUseOrigin()

Aligns bottom of AreaSeries to the Origin property value.
Default value: false

Returns:

boolean

setUseOrigin

public void setUseOrigin(boolean value)

Enables/disables the setting of the Y value (via the Origin property) that defines the bottom position for area points. Default value: false

Parameters:

value - boolean

See Also:

getOrigin()

getOrigin

public double getOrigin()

The axis value as a common bottom for all AreaSeries points.
Default value: O

Returns:

double

setOrigin

public void setOrigin(double value)

Sets axis value as a common bottom for all AreaSeries points.
Default value: O

Parameters:

value - double

getMaxYValue

public double getMaxYValue()

Returns the highest of all the current Series Y point values.

Overrides:

getMaxYValue in class CustomPoint

Returns:

double

getMinYValue

public double getMinYValue()

Returns the Minimum Value of the Series Y Values List.
As some Series have more than one Y Values List, this Minimum Value is the "Minimum of Minimums" of all Series Y Values lists.

Overrides:

getMinYValue in class CustomPoint

Returns:

double

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

getDescription

public java.lang.String getDescription()

Gets descriptive text.

Overrides:

getDescription in class Series

Returns:

String

getOriginPos

protected int getOriginPos(int valueIndex)

Overrides:

getOriginPos in class CustomPoint

prepareLegendCanvas

protected void prepareLegendCanvas(IGraphics3D g,
                                   int valueIndex,
                                   Color backColor,
                                   ChartBrush aBrush)

Overrides:

prepareLegendCanvas in class Series

createSubGallery

public void createSubGallery(Gallery addSubChart)

Overrides:

createSubGallery in class Series

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 Series

Parameters:

index - int

getLinePen

public ChartPen getLinePen()

Determines pen to draw the line connecting all points.

Returns:

ChartPen