org.apache.poi.xssf.usermodel.charts

Class XSSFValueAxis

java.lang.Object

org.apache.poi.xssf.usermodel.charts.XSSFChartAxis

org.apache.poi.xssf.usermodel.charts.XSSFValueAxis

All Implemented Interfaces:

ChartAxis, ValueAxis

@Beta
public class XSSFValueAxis
extends XSSFChartAxis
implements ValueAxis

Value axis type.

Author:

Roman Kashitsyn

Field Summary

Fields inherited from class org.apache.poi.xssf.usermodel.charts.XSSFChartAxis

chart

Constructor Summary

Constructors

Constructor and Description
XSSFValueAxis(XSSFChart chart, CTValAx ctValAx)
XSSFValueAxis(XSSFChart chart, long id, AxisPosition pos)

Method Summary

Modifier and Type	Method and Description
void	crossAxis(ChartAxis axis) Declare this axis cross another axis.
AxisCrossBetween	getCrossBetween()
protected CTAxPos	getCTAxPos()
protected CTCrosses	getCTCrosses()
protected CTNumFmt	getCTNumFmt()
protected CTScaling	getCTScaling()
protected CTBoolean	getDelete()
long	getId()
CTShapeProperties	getLine()
protected CTTickMark	getMajorCTTickMark()
CTChartLines	getMajorGridLines()
protected CTTickMark	getMinorCTTickMark()
boolean	hasNumberFormat() Use this to check before retrieving a number format, as calling ChartAxis.getNumberFormat() may create a default one if none exists.
void	setCrossBetween(AxisCrossBetween crossBetween)

Methods inherited from class org.apache.poi.xssf.usermodel.charts.XSSFChartAxis

getCrosses, getLogBase, getMajorTickMark, getMaximum, getMinimum, getMinorTickMark, getNumberFormat, 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

Methods inherited from interface org.apache.poi.ss.usermodel.charts.ChartAxis

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

Constructor Detail

XSSFValueAxis

public XSSFValueAxis(XSSFChart chart,
                     long id,
                     AxisPosition pos)

XSSFValueAxis

public XSSFValueAxis(XSSFChart chart,
                     CTValAx ctValAx)

Method Detail

getId

public long getId()

Specified by:

getId in interface ChartAxis

Returns:

axis id

getLine

@Internal
public CTShapeProperties getLine()

Specified by:

getLine in class XSSFChartAxis

setCrossBetween

public void setCrossBetween(AxisCrossBetween crossBetween)

Specified by:

setCrossBetween in interface ValueAxis

Parameters:

crossBetween - cross between type

getCrossBetween

public AxisCrossBetween getCrossBetween()

Specified by:

getCrossBetween in interface ValueAxis

Returns:

cross between type

getCTAxPos

protected CTAxPos getCTAxPos()

Specified by:

getCTAxPos in class XSSFChartAxis

getCTNumFmt

protected CTNumFmt getCTNumFmt()

Specified by:

getCTNumFmt in class XSSFChartAxis

getCTScaling

protected CTScaling getCTScaling()

Specified by:

getCTScaling in class XSSFChartAxis

getCTCrosses

protected CTCrosses getCTCrosses()

Specified by:

getCTCrosses in class XSSFChartAxis

getDelete

protected CTBoolean getDelete()

Specified by:

getDelete in class XSSFChartAxis

getMajorCTTickMark

protected CTTickMark getMajorCTTickMark()

Specified by:

getMajorCTTickMark in class XSSFChartAxis

getMinorCTTickMark

protected CTTickMark getMinorCTTickMark()

Specified by:

getMinorCTTickMark in class XSSFChartAxis

getMajorGridLines

@Internal
public CTChartLines getMajorGridLines()

Specified by:

getMajorGridLines in class XSSFChartAxis

crossAxis

public void crossAxis(ChartAxis axis)

Description copied from interface: ChartAxis

Declare this axis cross another axis.

Specified by:

crossAxis in interface ChartAxis

Parameters:

axis - that this axis should cross

hasNumberFormat

public boolean hasNumberFormat()

Description copied from interface: ChartAxis

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

Specified by:

hasNumberFormat in interface ChartAxis

Returns:

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