org.apache.poi.xddf.usermodel.chart

Class XDDFCategoryAxis

java.lang.Object

org.apache.poi.xddf.usermodel.chart.XDDFChartAxis

org.apache.poi.xddf.usermodel.chart.XDDFCategoryAxis

All Implemented Interfaces:

HasShapeProperties

@Beta
public class XDDFCategoryAxis
extends XDDFChartAxis

Constructor Summary

Constructors

Constructor and Description
XDDFCategoryAxis(org.openxmlformats.schemas.drawingml.x2006.chart.CTCatAx ctCatAx)
XDDFCategoryAxis(org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea plotArea, AxisPosition position)

Method Summary

Modifier and Type	Method and Description
void	crossAxis(XDDFChartAxis axis) Declare this axis cross another axis.
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTUnsignedInt	getCTAxId()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos	getCTAxPos()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTCrosses	getCTCrosses()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTNumFmt	getCTNumFmt()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTScaling	getCTScaling()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTBoolean	getDelete()
AxisLabelAlignment	getLabelAlignment()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark	getMajorCTTickMark()
double	getMajorUnit()
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark	getMinorCTTickMark()
double	getMinorUnit()
XDDFShapeProperties	getOrAddMajorGridProperties()
XDDFShapeProperties	getOrAddMinorGridProperties()
XDDFShapeProperties	getOrAddShapeProperties()
boolean	hasNumberFormat() Use this to check before retrieving a number format, as calling XDDFChartAxis.getNumberFormat() may create a default one if none exists.
boolean	isSetMajorUnit()
boolean	isSetMinorUnit()
void	setLabelAlignment(AxisLabelAlignment labelAlignment)
void	setMajorUnit(double major)
void	setMinorUnit(double minor)
void	setTitle(java.lang.String text)

Methods inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChartAxis

getCrosses, getId, getLogBase, getMajorTickMark, getMaximum, getMinimum, getMinorTickMark, getNextAxId, getNumberFormat, getOrAddLinesProperties, getOrientation, getPosition, isSetLogBase, isSetMaximum, isSetMinimum, isVisible, setCrosses, setLogBase, setMajorTickMark, setMaximum, setMinimum, setMinorTickMark, setNumberFormat, setOrientation, setPosition, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XDDFCategoryAxis

public XDDFCategoryAxis(org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea plotArea,
                        AxisPosition position)

XDDFCategoryAxis

public XDDFCategoryAxis(org.openxmlformats.schemas.drawingml.x2006.chart.CTCatAx ctCatAx)

Method Detail

getOrAddMajorGridProperties

public XDDFShapeProperties getOrAddMajorGridProperties()

Specified by:

getOrAddMajorGridProperties in class XDDFChartAxis

getOrAddMinorGridProperties

public XDDFShapeProperties getOrAddMinorGridProperties()

Specified by:

getOrAddMinorGridProperties in class XDDFChartAxis

getOrAddShapeProperties

public XDDFShapeProperties getOrAddShapeProperties()

setTitle

public void setTitle(java.lang.String text)

Specified by:

setTitle in class XDDFChartAxis

Since:

4.0.1

isSetMinorUnit

public boolean isSetMinorUnit()

Specified by:

isSetMinorUnit in class XDDFChartAxis

Returns:

true if minor unit value is defined, false otherwise

setMinorUnit

public void setMinorUnit(double minor)

Specified by:

setMinorUnit in class XDDFChartAxis

Parameters:

minor - axis minor unit

getMinorUnit

public double getMinorUnit()

Specified by:

getMinorUnit in class XDDFChartAxis

Returns:

axis minor unit or NaN if not set

isSetMajorUnit

public boolean isSetMajorUnit()

Specified by:

isSetMajorUnit in class XDDFChartAxis

Returns:

true if major unit value is defined, false otherwise

setMajorUnit

public void setMajorUnit(double major)

Specified by:

setMajorUnit in class XDDFChartAxis

Parameters:

major - axis major unit

getMajorUnit

public double getMajorUnit()

Specified by:

getMajorUnit in class XDDFChartAxis

Returns:

axis major unit or NaN if not set

crossAxis

public void crossAxis(XDDFChartAxis axis)

Description copied from class: XDDFChartAxis

Declare this axis cross another axis.

Specified by:

crossAxis in class XDDFChartAxis

Parameters:

axis - that this axis should cross

getCTAxId

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTUnsignedInt getCTAxId()

Specified by:

getCTAxId in class XDDFChartAxis

getCTAxPos

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos getCTAxPos()

Specified by:

getCTAxPos in class XDDFChartAxis

hasNumberFormat

public boolean hasNumberFormat()

Description copied from class: XDDFChartAxis

Use this to check before retrieving a number format, as calling XDDFChartAxis.getNumberFormat() may create a default one if none exists.

Specified by:

hasNumberFormat in class XDDFChartAxis

Returns:

true if a number format element is defined, false if not

getCTNumFmt

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTNumFmt getCTNumFmt()

Specified by:

getCTNumFmt in class XDDFChartAxis

getCTScaling

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTScaling getCTScaling()

Specified by:

getCTScaling in class XDDFChartAxis

getCTCrosses

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTCrosses getCTCrosses()

Specified by:

getCTCrosses in class XDDFChartAxis

getDelete

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTBoolean getDelete()

Specified by:

getDelete in class XDDFChartAxis

getMajorCTTickMark

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark getMajorCTTickMark()

Specified by:

getMajorCTTickMark in class XDDFChartAxis

getMinorCTTickMark

protected org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark getMinorCTTickMark()

Specified by:

getMinorCTTickMark in class XDDFChartAxis

getLabelAlignment

public AxisLabelAlignment getLabelAlignment()

setLabelAlignment

public void setLabelAlignment(AxisLabelAlignment labelAlignment)