Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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
`XSSFValueAxis(XSSFChart chart, org.openxmlformats.schemas.drawingml.x2006.chart.CTValAx ctValAx)`
`XSSFValueAxis(XSSFChart chart, long id, AxisPosition pos)`

Method Summary
`void` | `crossAxis(ChartAxis axis)` Declare this axis cross another axis.
`AxisCrossBetween` | `getCrossBetween()`
`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()`
`long` | `getId()`
`org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties` | `getLine()`
`protected org.openxmlformats.schemas.drawingml.x2006.chart.CTTickMark` | `getMajorCTTickMark()`
`org.openxmlformats.schemas.drawingml.x2006.chart.CTChartLines` | `getMajorGridLines()`
`protected org.openxmlformats.schemas.drawingml.x2006.chart.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,
                         org.openxmlformats.schemas.drawingml.x2006.chart.CTValAx ctValAx)

Method Detail

### getId

    public long getId()

  Specified by:
    `getId` in interface `ChartAxis`
  Returns:
    axis id

### getLine

    @Internal
    public org.openxmlformats.schemas.drawingml.x2006.main.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 org.openxmlformats.schemas.drawingml.x2006.chart.CTAxPos getCTAxPos()

  Specified by:
    `getCTAxPos` in class `XSSFChartAxis`

### getCTNumFmt

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

  Specified by:
    `getCTNumFmt` in class `XSSFChartAxis`

### getCTScaling

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

  Specified by:
    `getCTScaling` in class `XSSFChartAxis`

### getCTCrosses

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

  Specified by:
    `getCTCrosses` in class `XSSFChartAxis`

### getDelete

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

  Specified by:
    `getDelete` in class `XSSFChartAxis`

### getMajorCTTickMark

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

  Specified by:
    `getMajorCTTickMark` in class `XSSFChartAxis`

### getMinorCTTickMark

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

  Specified by:
    `getMinorCTTickMark` in class `XSSFChartAxis`

### getMajorGridLines

    @Internal
    public org.openxmlformats.schemas.drawingml.x2006.chart.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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.