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.ss.usermodel.charts
Interface ChartAxis

All Known Subinterfaces:
  ValueAxis

All Known Implementing Classes:
  XSSFCategoryAxis, XSSFChartAxis, XSSFDateAxis, XSSFValueAxis

    @Beta
    public interface ChartAxis

High level representation of chart axis.

Author:
  Roman Kashitsyn

Method Summary
`void` | `crossAxis(ChartAxis axis)` Declare this axis cross another axis.
`AxisCrosses` | `getCrosses()`
`long` | `getId()`
`double` | `getLogBase()`
`AxisTickMark` | `getMajorTickMark()`
`double` | `getMaximum()`
`double` | `getMinimum()`
`AxisTickMark` | `getMinorTickMark()`
`java.lang.String` | `getNumberFormat()`
`AxisOrientation` | `getOrientation()`
`AxisPosition` | `getPosition()`
`boolean` | `hasNumberFormat()` Use this to check before retrieving a number format, as calling `getNumberFormat()` may create a default one if none exists.
`boolean` | `isSetLogBase()`
`boolean` | `isSetMaximum()`
`boolean` | `isSetMinimum()`
`boolean` | `isVisible()`
`void` | `setCrosses(AxisCrosses crosses)`
`void` | `setLogBase(double logBase)`
`void` | `setMajorTickMark(AxisTickMark tickMark)`
`void` | `setMaximum(double max)`
`void` | `setMinimum(double min)`
`void` | `setMinorTickMark(AxisTickMark tickMark)`
`void` | `setNumberFormat(java.lang.String format)`
`void` | `setOrientation(AxisOrientation orientation)`
`void` | `setPosition(AxisPosition position)`
`void` | `setVisible(boolean value)`

Method Detail

### getId

    long getId()

  Returns:
    axis id

### getPosition

    AxisPosition getPosition()

  Returns:
    axis position

### setPosition

    void setPosition(AxisPosition position)

  Parameters:
    `position` - new axis position

### getNumberFormat

    java.lang.String getNumberFormat()

  Returns:
    axis number format

### setNumberFormat

    void setNumberFormat(java.lang.String format)

  Parameters:
    `format` - axis number format

### isSetLogBase

    boolean isSetLogBase()

  Returns:
    true if log base is defined, false otherwise

### setLogBase

    void setLogBase(double logBase)

  Parameters:
    `logBase` - a number between 2 and 1000 (inclusive)
  Throws:
    `java.lang.IllegalArgumentException` - if log base not within allowed range

### getLogBase

    double getLogBase()

  Returns:
    axis log base or 0.0 if not set

### isSetMinimum

    boolean isSetMinimum()

  Returns:
    true if minimum value is defined, false otherwise

### getMinimum

    double getMinimum()

  Returns:
    axis minimum or 0.0 if not set

### setMinimum

    void setMinimum(double min)

  Parameters:
    `min` - axis minimum

### isSetMaximum

    boolean isSetMaximum()

  Returns:
    true if maximum value is defined, false otherwise

### getMaximum

    double getMaximum()

  Returns:
    axis maximum or 0.0 if not set

### setMaximum

    void setMaximum(double max)

  Parameters:
    `max` - axis maximum

### getOrientation

    AxisOrientation getOrientation()

  Returns:
    axis orientation

### setOrientation

    void setOrientation(AxisOrientation orientation)

  Parameters:
    `orientation` - axis orientation

### setCrosses

    void setCrosses(AxisCrosses crosses)

  Parameters:
    `crosses` - axis cross type

### getCrosses

    AxisCrosses getCrosses()

  Returns:
    axis cross type

### crossAxis

    void crossAxis(ChartAxis axis)

  Declare this axis cross another axis.

  Parameters:
    `axis` - that this axis should cross

### isVisible

    boolean isVisible()

  Returns:
    visibility of the axis.

### setVisible

    void setVisible(boolean value)

  Parameters:
    `value` - visibility of the axis.

### getMajorTickMark

    AxisTickMark getMajorTickMark()

  Returns:
    major tick mark.

### setMajorTickMark

    void setMajorTickMark(AxisTickMark tickMark)

  Parameters:
    `tickMark` - major tick mark type.

### getMinorTickMark

    AxisTickMark getMinorTickMark()

  Returns:
    minor tick mark.

### setMinorTickMark

    void setMinorTickMark(AxisTickMark tickMark)

  Parameters:
    `tickMark` - minor tick mark type.

### hasNumberFormat

    boolean hasNumberFormat()

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

  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.