com.steema.teechart.axis
Class GridPen

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.drawing.ChartPen
          extended by com.steema.teechart.axis.GridPen

public class GridPen
extends ChartPen

Title: GridPen class

Description: Determines the kind of pen used to draw the Grid lines at every Axis Label position.

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

Company: Steema Software SL


Field Summary
protected  boolean centered
          When centered is true, grid is displayed in between axis labels.
 
Fields inherited from class com.steema.teechart.drawing.ChartPen
color, dashCap, dashStyle, defaultColor, defaultEndCap, defaultStyle, defaultVisible, endCap, usesVisible, visible, width
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
GridPen(IBaseChart chart)
          Creates a new Grid pen.
 
Method Summary
 boolean getCentered()
          Aligns the Grid to the centre.
 int getDrawEvery()
          Returns the Grid drawing intervals.
 DashStyle getStyle()
          Determines the style of the axis grid lines.
 double getZPosition()
          Returns the Z position of the Grid lines, in percent of total chart depth.
 void setCentered(boolean value)
          Sets grid lines to display between axis labels or at label positions.
 void setDrawEvery(int value)
          Sets the Grid to draw every corresponding value.
 void setZPosition(double value)
          Sets the Z position of Grid lines in percentage of total chart depth.
 
Methods inherited from class com.steema.teechart.drawing.ChartPen
assign, assign, getColor, getDashCap, getEndCap, getTransparency, getVisible, getWidth, internalAssign, invalidate, reset, setColor, setDashCap, setDefaultColor, setDefaultStyle, setDefaultVisible, setEndCap, setStyle, setTransparency, setUsesVisible, setVisible, setWidth, shouldSerializeColor, shouldSerializeEndCap, shouldSerializeStyle, shouldSerializeVisible
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

centered

protected boolean centered
When centered is true, grid is displayed in between axis labels. When false, grid lines are drawn at axis labels positions.

Constructor Detail

GridPen

public GridPen(IBaseChart chart)
Creates a new Grid pen.

Parameters:
chart - IBaseChart
Method Detail

getStyle

public DashStyle getStyle()
Determines the style of the axis grid lines.
It sets both vertical and horizontal lines independently.
DefaultValue: DashStyle.DOT

Overrides:
getStyle in class ChartPen
Returns:
DashStyle

getCentered

public boolean getCentered()
Aligns the Grid to the centre.
DefaultValue: false

Returns:
boolean

setCentered

public void setCentered(boolean value)
Sets grid lines to display between axis labels or at label positions.

Parameters:
value - boolean

getZPosition

public double getZPosition()
Returns the Z position of the Grid lines, in percent of total chart depth.

Returns:
double

setZPosition

public void setZPosition(double value)
Sets the Z position of Grid lines in percentage of total chart depth.

Parameters:
value - double

setDrawEvery

public void setDrawEvery(int value)
Sets the Grid to draw every corresponding value.

Parameters:
value - int

getDrawEvery

public int getDrawEvery()
Returns the Grid drawing intervals.

Returns:
int