com.steema.teechart.styles
Class ColorGrid

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

public class ColorGrid
extends Custom3DGrid

Title: ColorGrid class

Description: The ColorGrid series displays a grid of color cells.

Example:


 series = new ColorGrid(myChart.getChart());
 series.getPen().setColor(Color.WHITE);
 series.setUsePalette(true);
 series.setPaletteStyle(PaletteStyle.STRONG);
 eries.setUseColorRange(false);s
 series.fillSampleValues(20);
 

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
ColorGrid()
           
ColorGrid(IBaseChart c)
           
 
Method Summary
 double calcMinValue(double Value)
           
 int calcXPos(int index)
          The pixel Screen Horizontal coordinate of the ValueIndex Series value.
 int calcYPos(int index)
          The pixel Screen Vertical coordinate of the ValueIndex Series value.
 int clicked(int X, int Y)
          Returns the ValueIndex of the "clicked" point in the Series.
 void createSubGallery(Gallery addSubChart)
           
protected  void draw()
           
protected  void drawMark(int valueIndex, java.lang.String st, SeriesMarksPosition aPosition)
           
 void galleryChanged3D(boolean is3D)
           
 boolean getCenteredPoints()
          Controls how "X" and "Z" values will be considered.
 java.lang.String getDescription()
          Gets descriptive text
 Image getImage()
          Use this property to display a bitmap within a ColorGrid.
 double getMaxXValue()
          The Maximum Value of the Series X Values List.
 double getMaxYValue()
          The Maximum Value of the Series Y Values List.
 double getMaxZValue()
          The Maximum Value of the Series Z Values List.
 double getMinXValue()
          The Minimum Value of the Series X Values List.
 double getMinYValue()
          The Minimum Value of the Series Y Values List.
 double getMinZValue()
          The Minimum Value of the Series Z Values List.
 void setCenteredPoints(boolean value)
          Controls how "X" and "Z" values will be considered.
 void setImage(Image bitmap)
           
 void setSubGallery(int index)
          Creates and prepares the index'th Series style to show at sub-gallery dialog.
 
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, getBlueFactor, getBrush, getCountLegendItems, getEndColor, getGreenFactor, getLegendString, getMidColor, getPalette, getPaletteMin, getPaletteRange, getPaletteStep, getPaletteSteps, getPaletteStyle, getPen, getRedFactor, getStartColor, getUseColorRange, getUsePalette, getUsePaletteMin, getValueColor, getValueColorValue, legendItemColor, prepareForGallery, 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, calcXPosValue, calcXSizeValue, calcYPosValue, calcYSizeValue, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clearLists, 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, getMiddleZ, 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

ColorGrid

public ColorGrid(IBaseChart c)

ColorGrid

public ColorGrid()
Method Detail

createSubGallery

public void createSubGallery(Gallery addSubChart)
Overrides:
createSubGallery 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

getDescription

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

Overrides:
getDescription in class Series
Returns:
String

calcMinValue

public double calcMinValue(double Value)

calcYPos

public int calcYPos(int index)
Description copied from class: Series
The pixel Screen Vertical coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Vertical Axis.

Overrides:
calcYPos in class Series
Parameters:
index - int
Returns:
int

calcXPos

public int calcXPos(int index)
Description copied from class: Series
The pixel Screen Horizontal coordinate of the ValueIndex Series value.
This coordinate is calculated using the Series associated Horizontal Axis.

Overrides:
calcXPos in class Series
Parameters:
index - int
Returns:
int

clicked

public int clicked(int X,
                   int Y)
Description copied from class: Series
Returns the ValueIndex of the "clicked" point in the Series.
Clicked means the X and Y coordinates are in the point screen region bounds. If no point is "touched", Clicked returns -1

Specified by:
clicked in interface ISeries
Overrides:
clicked in class Series
Parameters:
X - int
Y - int
Returns:
int

getCenteredPoints

public boolean getCenteredPoints()
Controls how "X" and "Z" values will be considered.
When CenteredPoints is true, X and Z values determine the center point of each grid cell.
When false, the X and Z values define the "corner" values of grid cells. Thus, when CenteredPoints is false, there will be one less column and one less row of grid cells.
Default value: false

Returns:
boolean

setCenteredPoints

public void setCenteredPoints(boolean value)
Controls how "X" and "Z" values will be considered.
Default value: false

Parameters:
value - boolean
See Also:
getCenteredPoints()

getImage

public Image getImage()
Use this property to display a bitmap within a ColorGrid.
Example
This sample shows how to use the ColorGrid.Bitmap property:

private void SetFlower() {
InputStream ms = new InputStream();
Image flower = pictureBox1.Image;
flower.Save(ms, ImageFormat.Jpeg);
Bitmap bm = new Bitmap(ms);
colorGrid1.Bitmap = bm;

Returns:
Image

setImage

public void setImage(Image bitmap)

draw

protected void draw()
Overrides:
draw in class Series

drawMark

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

galleryChanged3D

public void galleryChanged3D(boolean is3D)
Overrides:
galleryChanged3D in class Custom3DPalette

getMinXValue

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

Overrides:
getMinXValue in class Series
Returns:
double

getMaxXValue

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

Overrides:
getMaxXValue in class Series
Returns:
double

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

getMaxZValue

public double getMaxZValue()
The Maximum Value of the Series Z Values List.

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

getMinZValue

public double getMinZValue()
The Minimum Value of the Series Z Values List.

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