Class XDDFChartAxis
java.lang.Object
org.apache.poi.xddf.usermodel.chart.XDDFChartAxis
- All Implemented Interfaces:
HasShapeProperties
- Direct Known Subclasses:
XDDFCategoryAxis
,XDDFDateAxis
,XDDFSeriesAxis
,XDDFValueAxis
Base class for all axis types.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
crossAxis
(XDDFChartAxis axis) Declare this axis cross another axis.protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTUnsignedInt
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTCrosses
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTNumFmt
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTScaling
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTBoolean
long
getId()
double
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark
abstract double
double
double
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark
abstract double
protected long
getNextAxId
(org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea plotArea) protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties
getOrAddLinesProperties
(org.openxmlformats.schemas.drawingml.x2006.chart.CTChartLines gridlines) abstract XDDFShapeProperties
abstract XDDFShapeProperties
abstract boolean
Use this to check before retrieving a number format, as callinggetNumberFormat()
may create a default one if none exists.boolean
abstract boolean
boolean
boolean
abstract boolean
boolean
void
setCrosses
(AxisCrosses crosses) void
setLogBase
(double logBase) void
setMajorTickMark
(AxisTickMark tickMark) abstract void
setMajorUnit
(double major) void
setMaximum
(double max) void
setMinimum
(double min) void
setMinorTickMark
(AxisTickMark tickMark) abstract void
setMinorUnit
(double minor) void
setNumberFormat
(String format) void
setOrientation
(AxisOrientation orientation) void
setPosition
(AxisPosition position) abstract void
void
setVisible
(boolean value) 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.xddf.usermodel.HasShapeProperties
getOrAddShapeProperties
-
Constructor Details
-
XDDFChartAxis
public XDDFChartAxis()
-
-
Method Details
-
getCTAxId
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTUnsignedInt getCTAxId() -
getCTAxPos
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos getCTAxPos() -
getCTNumFmt
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTNumFmt getCTNumFmt() -
getCTScaling
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTScaling getCTScaling() -
getCTCrosses
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTCrosses getCTCrosses() -
getDelete
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTBoolean getDelete() -
getMajorCTTickMark
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark getMajorCTTickMark() -
getMinorCTTickMark
protected abstract org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark getMinorCTTickMark() -
getOrAddMajorGridProperties
-
getOrAddMinorGridProperties
-
setTitle
- Since:
- 4.0.1
-
isSetMinorUnit
public abstract boolean isSetMinorUnit()- Returns:
- true if minor unit value is defined, false otherwise
-
setMinorUnit
public abstract void setMinorUnit(double minor) - Parameters:
minor
- axis minor unit
-
getMinorUnit
public abstract double getMinorUnit()- Returns:
- axis minor unit or NaN if not set
-
isSetMajorUnit
public abstract boolean isSetMajorUnit()- Returns:
- true if major unit value is defined, false otherwise
-
setMajorUnit
public abstract void setMajorUnit(double major) - Parameters:
major
- axis major unit
-
getMajorUnit
public abstract double getMajorUnit()- Returns:
- axis major unit or NaN if not set
-
getId
public long getId()- Returns:
- axis id
-
getPosition
- Returns:
- axis position
-
setPosition
- Parameters:
position
- new axis position
-
hasNumberFormat
public abstract boolean hasNumberFormat()Use this to check before retrieving a number format, as callinggetNumberFormat()
may create a default one if none exists.- Returns:
- true if a number format element is defined, false if not
-
setNumberFormat
- Parameters:
format
- axis number format
-
getNumberFormat
- Returns:
- axis number format
-
isSetLogBase
public boolean isSetLogBase()- Returns:
- true if log base is defined, false otherwise
-
setLogBase
public void setLogBase(double logBase) - Parameters:
logBase
- a number between 2 and 1000 (inclusive)- Throws:
IllegalArgumentException
- if log base not within allowed range
-
getLogBase
public double getLogBase()- Returns:
- axis log base or NaN if not set
-
isSetMinimum
public boolean isSetMinimum()- Returns:
- true if minimum value is defined, false otherwise
-
setMinimum
public void setMinimum(double min) - Parameters:
min
- axis minimum
-
getMinimum
public double getMinimum()- Returns:
- axis minimum or NaN if not set
-
isSetMaximum
public boolean isSetMaximum()- Returns:
- true if maximum value is defined, false otherwise
-
setMaximum
public void setMaximum(double max) - Parameters:
max
- axis maximum
-
getMaximum
public double getMaximum()- Returns:
- axis maximum or NaN if not set
-
getOrientation
- Returns:
- axis orientation
-
setOrientation
- Parameters:
orientation
- axis orientation
-
getCrosses
- Returns:
- axis cross type
-
setCrosses
- Parameters:
crosses
- axis cross type
-
crossAxis
Declare this axis cross another axis.- Parameters:
axis
- that this axis should cross
-
isVisible
public boolean isVisible()- Returns:
- visibility of the axis.
-
setVisible
public void setVisible(boolean value) - Parameters:
value
- visibility of the axis.
-
getMajorTickMark
- Returns:
- major tick mark.
-
setMajorTickMark
- Parameters:
tickMark
- major tick mark type.
-
getMinorTickMark
- Returns:
- minor tick mark.
-
setMinorTickMark
- Parameters:
tickMark
- minor tick mark type.
-
getOrAddLinesProperties
protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getOrAddLinesProperties(org.openxmlformats.schemas.drawingml.x2006.chart.CTChartLines gridlines) -
getNextAxId
protected long getNextAxId(org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea plotArea)
-