DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.charting.axes
Class YAxis

java.lang.Object
  extended by com.cete.dynamicpdf.pageelements.charting.Axis
      extended by com.cete.dynamicpdf.pageelements.charting.axes.YAxis
Direct Known Subclasses:
DateTimeYAxis, IndexedYAxis, NumericYAxis, PercentageYAxis

public abstract class YAxis
extends Axis

Class provides the base class from which all y-axes are derived.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:


Method Summary
 YAxisAnchorType getAnchorType()
          Gets YAxisAnchorType enumeration that specifies the position of the y-axis.
 YAxisLabelPosition getLabelPosition()
          Gets YAxisLabelPosition enumeration that specifies the position of the labels.
 YAxisGridLines getMajorGridLines()
          Gets the YAxisGridLines object to use for the major gridlines of the y-axis.
 YAxisTickMarks getMajorTickMarks()
          Gets the YAxisTickMarks object to use for the major tickmarks of the y-axis.
 YAxisGridLines getMinorGridLines()
          Gets the YAxisGridLines object to use for the minor gridlines of the y-axis.
 YAxisTickMarks getMinorTickMarks()
          Gets the YAxisTickMarks object to use for the minor tickmarks of the y-axis.
 YAxisTitlePosition getTitlePosition()
          Gets YAxisTitlePosition enumeration that specifies the position of the title.
 TitleList getTitles()
          Gets the Title object to use for the title of the y-axis.
 void setAnchorType(YAxisAnchorType yAnchorType)
          Sets YAxisAnchorType enumeration that specifies the position of the y-axis.
 void setLabelPosition(YAxisLabelPosition yAxisLabelPosition)
          Sets YAxisLabelPosition enumeration that specifies the position of the labels.
 void setMajorGridLines(YAxisGridLines majorYGridLines)
          Sets the YAxisGridLines object to use for the major gridlines of the y-axis.
 void setMajorTickMarks(YAxisTickMarks majorYTickMarks)
          Sets the YAxisTickMarks object to use for the major tickmarks of the y-axis.
 void setMinorGridLines(YAxisGridLines minorYGridLines)
          Sets the YAxisGridLines object to use for the minor gridlines of the y-axis.
 void setMinorTickMarks(YAxisTickMarks minorYTickMarks)
          Sets the YAxisTickMarks object to use for the minor tickmarks of the y-axis.
 void setTitlePosition(YAxisTitlePosition yAxisTitlePosition)
          Sets YAxisTitlePosition enumeration that specifies the position of the title.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.charting.Axis
getLabelFormat, getLabelOffset, getLineColor, getLineStyle, getLineWidth, getOffset, isVisible, setLabelFormat, setLabelOffset, setLineColor, setLineStyle, setLineWidth, setOffset, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAnchorType

public YAxisAnchorType getAnchorType()
Gets YAxisAnchorType enumeration that specifies the position of the y-axis.

Returns:
the YAxisAnchorType enumeration that specifies the position of the y-axis.
See Also:
YAxisAnchorType

setAnchorType

public void setAnchorType(YAxisAnchorType yAnchorType)
Sets YAxisAnchorType enumeration that specifies the position of the y-axis.

Parameters:
yAnchorType - the YAxisAnchorType enumeration that specifies the position of the y-axis.
See Also:
YAxisAnchorType

getLabelPosition

public YAxisLabelPosition getLabelPosition()
Gets YAxisLabelPosition enumeration that specifies the position of the labels.

Returns:
the YAxisLabelPosition enumeration that specifies the position of the labels.
See Also:
YAxisLabelPosition

setLabelPosition

public void setLabelPosition(YAxisLabelPosition yAxisLabelPosition)
Sets YAxisLabelPosition enumeration that specifies the position of the labels.

Parameters:
yAxisLabelPosition - the YAxisLabelPosition enumeration that specifies the position of the labels.
See Also:
YAxisLabelPosition

getMajorGridLines

public YAxisGridLines getMajorGridLines()
Gets the YAxisGridLines object to use for the major gridlines of the y-axis.

Returns:
the YAxisGridLines object used for the major grid lines of the y-axis.
See Also:
YAxisGridLines

setMajorGridLines

public void setMajorGridLines(YAxisGridLines majorYGridLines)
Sets the YAxisGridLines object to use for the major gridlines of the y-axis.

Parameters:
majorYGridLines - the YAxisGridLines object to use for the major grid lines of the y-axis.
See Also:
YAxisGridLines

getMinorGridLines

public YAxisGridLines getMinorGridLines()
Gets the YAxisGridLines object to use for the minor gridlines of the y-axis.

Returns:
the YAxisGridLines object used for the minor grid lines of the yAxis.
See Also:
YAxisGridLines

setMinorGridLines

public void setMinorGridLines(YAxisGridLines minorYGridLines)
Sets the YAxisGridLines object to use for the minor gridlines of the y-axis.

Parameters:
minorYGridLines - the YAxisGridLines object to use for the minor gridlines of the y-axis.
See Also:
YAxisGridLines

getMajorTickMarks

public YAxisTickMarks getMajorTickMarks()
Gets the YAxisTickMarks object to use for the major tickmarks of the y-axis.

Returns:
the YAxisTickMarks object used for the major tickmarks of the y-axis.
See Also:
YAxisTickMarks

setMajorTickMarks

public void setMajorTickMarks(YAxisTickMarks majorYTickMarks)
Sets the YAxisTickMarks object to use for the major tickmarks of the y-axis.

Parameters:
majorYTickMarks - the YTickMarks object to use for the major tickmarks of the y-axis.
See Also:
YAxisTickMarks

getMinorTickMarks

public YAxisTickMarks getMinorTickMarks()
Gets the YAxisTickMarks object to use for the minor tickmarks of the y-axis.

Returns:
the YAxisTickMarks object used for the minor tickmarks of the y-axis.
See Also:
YAxisTickMarks

setMinorTickMarks

public void setMinorTickMarks(YAxisTickMarks minorYTickMarks)
Sets the YAxisTickMarks object to use for the minor tickmarks of the y-axis.

Parameters:
minorYTickMarks - the YTickMarks object to use for the minor tick marks of the y-axis.
See Also:
YAxisTickMarks

getTitles

public TitleList getTitles()
Gets the Title object to use for the title of the y-axis.

Returns:
the list.
See Also:
Title

getTitlePosition

public YAxisTitlePosition getTitlePosition()
Gets YAxisTitlePosition enumeration that specifies the position of the title.

Returns:
the YAxisTitlePosition enumeration that specifies the position of the title.
See Also:
YAxisTitlePosition

setTitlePosition

public void setTitlePosition(YAxisTitlePosition yAxisTitlePosition)
Sets YAxisTitlePosition enumeration that specifies the position of the title.

Parameters:
yAxisTitlePosition - the YAxisTitlePosition enumeration that specifies the position of the title.
See Also:
YAxisTitlePosition

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.07 for Java generated on Aug 12, 2020
© Copyright 2020, ceTe Software