ChartAxes (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.charts.ChartAxes

All Implemented Interfaces:

ChartConstants, Serializable
```
public class ChartAxes
extends Object
implements ChartConstants, Serializable
```
An axis group is a set of axes that specify a coordinate system, a set of chart groups that are plotted using these and the plot area that defines where the axes are rendered on the chart. In BIFF8, the AxisParent record governs the Axis Group. A typical arrangement of records is: AxisParent Pos Axis (X) Axis (Y) PlotArea Frame (Chart Group is one or more of:) ChartFormat (defines the chart type) + Legend

See Also:

Serialized Form

Field Summary
- Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants
  AREACHART, BARCHART, BUBBLECHART, COLCHART, CONEBARCHART, CONECHART, CYLINDERBARCHART, CYLINDERCHART, DOUGHNUTCHART, LINECHART, OFPIECHART, PIECHART, PYRAMIDBARCHART, PYRAMIDCHART, RADARAREACHART, RADARCHART, SCATTERCHART, SHAPECOLUMN, SHAPECONE, SHAPECONETOMAX, SHAPECYLINDER, SHAPEDEFAULT, SHAPEPYRAMID, SHAPEPYRAMIDTOMAX, STOCKCHART, SURFACECHART, XAXIS, XVALAXIS, YAXIS, ZAXIS

Constructor Summary

Constructors
Constructor and Description

ChartAxes(AxisParent ap)

Constructors
Constructor and Description
`ChartAxes(AxisParent ap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Axis a)` store each axis
`void`	`close()`
`void`	`createAxis(int axisType)`
`boolean`	`getAxisAutomaticScale()` Returns true if the Y Axis (Value axis) is set to automatic scale
`boolean`	`getAxisAutomaticScale(int axisType)` Returns true if the desired Value axis is set to automatic scale
`int`	`getAxisMajorUnit(int axisType)` Returns the major tick unit of the desired Value axis
`int`	`getAxisMinorUnit(int axisType)` Returns the minor tick unit of the desired Value axis
`String`	`getAxisOptionsXML(int axisType)` obtain the desired axis' label and other options, if present, in XML form
`int`	`getAxisPlacement(int axisType)` returns the Axis Label Placement or position as an int
`float[]`	`getCoords(int axisType)` return the coordinates, in pixels, of the title text area, if possible
`org.json.JSONObject`	`getJSON(int axisType, WorkBookHandle wbh, int chartType, double yMax, double yMin, int nSeries)`
`Font`	`getLabelFont(int axisType)` returns the label font for the desired axis.
`int`	`getLabelRotation(int axisType)` return the rotation of the axis labels, if any 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
`Object`	`getMetric(String metric)` returns a specific axis Metric Use only after calling chart.getMetrics
`HashMap`	`getMetrics()` returns already-set axisMetrics Used only after calling chart.getMetrics
`HashMap<String,Object>`	`getMetrics(int charttype, HashMap<String,Double> chartMetrics, float[] plotcoords, Object[] categories)` generate Axis Metrics -- minor, major scale, title and label offsets, etc.
`double[]`	`getMinMax(double ymin, double ymax)` Returns the YAXIS scale elements (min value, max value, minor (tick) scale, major (tick) scale) the scale elements are calculated from the minimum and maximum values on the chart
`double[]`	`getMinMax(double ymin, double ymax, int axisType)` Returns the scale values of the the desired Value axis Scale elements: (min value, max value, minor (tick) scale, major (tick) scale)
`protected String`	`getNumberFormat(int axisType)` returns the number format for the desired axis
`String`	`getOOXML(int axisType, int type, String id, String crossId)` returns the OOXML necessary to define the desired axis
`String`	`getPlotAreaBgColor()` returns the axis area background color hex string, or null if not set
`float[]`	`getPlotAreaCoords(float w, float h)` return the coordinates of the outer plot area (plot + axes + labels) in pixels
`String`	`getSVG(int axisType, Map<String,Double> chartMetrics, Object[] categories)` returns the SVG necesssary to define the desired axis
`String`	`getTitle(int axisType)` Return the Axis Title, or "" if none
`Font`	`getTitleFont(int axisType)` returns the font for the title for the desired axis
`int`	`getTitleRotation(int axisType)` return the rotation of the axis Title, if any 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
`boolean`	`hasAxis(int axisType)` returns true if axisType is found on chart
`protected boolean`	`isReversed(int axisType)` returns true if Axis is reversed
`void`	`parseOOXML(int axisType, org.xmlpull.v1.XmlPullParser xpp, String tnm, Stack<String> lastTag, WorkBookHandle bk)` parse OOXML axis element
`void`	`removeAxes()` remove ALL axes from this chart
`void`	`removeAxis(int axisType)` remove the desired axis + associated records
`void`	`setAxisAutomaticScale(boolean b)` Sets the automatic scale option on or off for the Y Axis (Value axis)
`void`	`setAxisAutomaticScale(int axisType, boolean b)` Sets the automatic scale option on or off for the desired Value axis
`void`	`setAxisMax(int MaxValue)` Sets the maximum value of the Y Axis (Value Axis) Scale
`void`	`setAxisMax(int axisType, int MaxValue)` Sets the maximum scale value of the desired Value axis
`void`	`setAxisMin(int MinValue)` Sets the minimum value of the Y Axis (Value Axis) Scale
`void`	`setAxisMin(int axisType, int MinValue)` Sets the minimum scale value of the desired Value axis
`void`	`setAxisPlacement(int axisType, int placement)` sets the axis labels position or placement to the desired value (these match Excel placement options)
`void`	`setChartOption(int axisType, String op, String val)` sets an option for this axis
`void`	`setPlotAreaBgColor(int bg)` sets the plot area background color
`void`	`setPlotAreaBorder(int lw, int lclr)` adds a border around the plot area with the desired line width and line color
`void`	`setTd(int axisType, TextDisp td)`
`void`	`setTitle(int axisType, String Title)` set the axis title string
`void`	`setTitleFont(int axisType, int fondId)` set the font index for this Axis (for title)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChartAxes
```
public ChartAxes(AxisParent ap)
```
    Parameters:
    
    ap -
- Method Detail
  - add
```
public void add(Axis a)
```
    store each axis
    
    Parameters:
    
    a -
  - setTd
```
public void setTd(int axisType,
                  TextDisp td)
```
  - hasAxis
```
public boolean hasAxis(int axisType)
```
    returns true if axisType is found on chart
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
  - createAxis
```
public void createAxis(int axisType)
```
  - isReversed
```
protected boolean isReversed(int axisType)
```
    returns true if Axis is reversed
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
  - getNumberFormat
```
protected String getNumberFormat(int axisType)
```
    returns the number format for the desired axis
    
    Parameters:
    
    axisType -
    
    Returns:
    
    number format string
  - removeAxes
```
public void removeAxes()
```
    remove ALL axes from this chart
  - removeAxis
```
public void removeAxis(int axisType)
```
    remove the desired axis + associated records
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
  - getPlotAreaCoords
```
public float[] getPlotAreaCoords(float w,
                                 float h)
```
    return the coordinates of the outer plot area (plot + axes + labels) in pixels
    
    Returns:
  - getPlotAreaBgColor
```
public String getPlotAreaBgColor()
```
    returns the axis area background color hex string, or null if not set
    
    Returns:
    
    color hex string
  - setPlotAreaBgColor
```
public void setPlotAreaBgColor(int bg)
```
    sets the plot area background color
    
    Parameters:
    
    bg - color int
  - setPlotAreaBorder
```
public void setPlotAreaBorder(int lw,
                              int lclr)
```
    adds a border around the plot area with the desired line width and line color
    
    Parameters:
    
    lw -
    
    lclr -
  - getAxisOptionsXML
```
public String getAxisOptionsXML(int axisType)
```
    obtain the desired axis' label and other options, if present, in XML form
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    String XML representation of desired axis' label and options
    
    See Also:
    
    ObjectLink
  - getTitle
```
public String getTitle(int axisType)
```
    Return the Axis Title, or "" if none
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
  - setTitle
```
public void setTitle(int axisType,
                     String Title)
```
    set the axis title string
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Title -
  - getLabelRotation
```
public int getLabelRotation(int axisType)
```
    return the rotation of the axis labels, if any 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
  - getTitleRotation
```
public int getTitleRotation(int axisType)
```
    return the rotation of the axis Title, if any 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
  - getCoords
```
public float[] getCoords(int axisType)
```
    return the coordinates, in pixels, of the title text area, if possible
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    float[]
  - getMinMax
```
public double[] getMinMax(double ymin,
                          double ymax)
```
    Returns the YAXIS scale elements (min value, max value, minor (tick) scale, major (tick) scale) the scale elements are calculated from the minimum and maximum values on the chart
    
    Parameters:
    
    ymin - the minimum value of all the series values
    
    ymax - the maximum value of all the series values
    
    Returns:
    
    double[] min, max, minor, major
  - getMinMax
```
public double[] getMinMax(double ymin,
                          double ymax,
                          int axisType)
```
    Returns the scale values of the the desired Value axis
    Scale elements: (min value, max value, minor (tick) scale, major (tick) scale)
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    
    Parameters:
    
    int - axisType - one of ChartHandle.YAXIS, ChartHandle.XAXIS, ChartHandle.ZAXIS
    
    Returns:
    
    int Miminum Scale value for the desired axis
    
    See Also:
    
    getAxisMinScale()
  - getAxisMajorUnit
```
public int getAxisMajorUnit(int axisType)
```
    Returns the major tick unit of the desired Value axis
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    int major tick unit
    
    See Also:
    
    getAxisMajorUnit()
  - getAxisMinorUnit
```
public int getAxisMinorUnit(int axisType)
```
    Returns the minor tick unit of the desired Value axis
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    int - minor tick unit of the desired axis
    
    See Also:
    
    getAxisMinorUnit()
  - setAxisMax
```
public void setAxisMax(int axisType,
                       int MaxValue)
```
    Sets the maximum scale value of the desired Value axis
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    Note: The default scale setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale as necessary
    Setting the scale manually (either Minimum or Maximum Value) removes Automatic Scaling
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    int - MaxValue - desired maximum value of the desired axis
    
    See Also:
    
    setAxisMax(int MaxValue)
  - setAxisMin
```
public void setAxisMin(int axisType,
                       int MinValue)
```
    Sets the minimum scale value of the desired Value axis
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    Note: The default setting for charts is known as Automatic Scaling
    When data values change, the chart automatically adjusts the scale as necessary
    Setting the scale manually (either Minimum or Maximum Value) removes Automatic Scaling
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    int - MinValue - the desired Minimum scale value
    
    See Also:
    
    setAxisMin(int MinValue)
  - setAxisAutomaticScale
```
public void setAxisAutomaticScale(int axisType,
                                  boolean b)
```
    Sets the automatic scale option on or off for the desired Value axis
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    Automatic Scaling automatically sets the scale maximum, minimum and tick units upon data changes, and is the default setting for charts
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    boolean - b - true if set Automatic scaling on, false otherwise
    
    See Also:
    
    setAxisAutomaticScale(boolean b)
  - getAxisAutomaticScale
```
public boolean getAxisAutomaticScale(int axisType)
```
    Returns true if the desired Value axis is set to automatic scale
    The Value axis contains numbers rather than labels, and is normally the Y axis, but Scatter and Bubble charts may have a value axis on the X Axis as well
    Note: The default setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale as necessary
    Setting the scale manually (either Minimum or Maximum Value) removes Automatic Scaling
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    boolean true if Automatic Scaling is turned on
    
    See Also:
    
    getAxisAutomaticScale()
  - getAxisAutomaticScale
```
public boolean getAxisAutomaticScale()
```
    Returns true if the Y Axis (Value axis) is set to automatic scale
    The default setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale (minimum, maximum values plus major and minor tick units) as necessary
    
    Returns:
    
    boolean true if Automatic Scaling is turned on
    
    See Also:
    
    getAxisAutomaticScale(int axisType)
  - setAxisAutomaticScale
```
public void setAxisAutomaticScale(boolean b)
```
    Sets the automatic scale option on or off for the Y Axis (Value axis)
    Automatic Scaling will automatically set the scale maximum, minimum and tick units upon data changes, and is the default chart setting
    
    Parameters:
    
    b -
    
    See Also:
    
    setAxisAutomaticScale(int axisType boolean b)
  - setAxisMax
```
public void setAxisMax(int MaxValue)
```
    Sets the maximum value of the Y Axis (Value Axis) Scale
    Note: The default scale setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale as necessary
    Setting the scale manually (either Minimum or Maximum Value) removes Automatic Scaling
    
    Parameters:
    
    int - MaxValue - the desired maximum scale value
    
    See Also:
    
    ChartHandle.setAxisMax(int axisType, int MaxValue)
  - setAxisMin
```
public void setAxisMin(int MinValue)
```
    Sets the minimum value of the Y Axis (Value Axis) Scale
    Note: The default setting for charts is known as Automatic Scaling
    When data changes, the chart automatically adjusts the scale as necessary
    Setting the scale manually (either Minimum or Maximum Value) removes Automatic Scaling
    
    Parameters:
    
    int - MinValue - the desired minimum scale value
    
    See Also:
    
    ChartHandle.setAxisMin(int axisType, int MinValue)
  - getSVG
```
public String getSVG(int axisType,
                     Map<String,Double> chartMetrics,
                     Object[] categories)
```
    returns the SVG necesssary to define the desired axis
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    chartMetrics - maps chart coords in pixels x, y, w, h, canvasw, canvash, min, max
    
    Returns:
  - getOOXML
```
public String getOOXML(int axisType,
                       int type,
                       String id,
                       String crossId)
```
    returns the OOXML necessary to define the desired axis
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    type -
    
    id -
    
    crossId -
    
    Returns:
  - setTitleFont
```
public void setTitleFont(int axisType,
                         int fondId)
```
    set the font index for this Axis (for title)
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    fondId -
  - getTitleFont
```
public Font getTitleFont(int axisType)
```
    returns the font for the title for the desired axis
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
  - getLabelFont
```
public Font getLabelFont(int axisType)
```
    returns the label font for the desired axis. If not explicitly set, returns the default font
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
  - getJSON
```
public org.json.JSONObject getJSON(int axisType,
                                   WorkBookHandle wbh,
                                   int chartType,
                                   double yMax,
                                   double yMin,
                                   int nSeries)
```
  - setChartOption
```
public void setChartOption(int axisType,
                           String op,
                           String val)
```
    sets an option for this axis
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    op - option name; one of: CatCross, LabelCross, Marks, CrossBetween, CrossMax, MajorGridLines, AddArea, AreaFg, AreaBg or Linked Text Display options: Label, ShowKey, ShowValue, ShowLabelPct, ShowPct, ShowCatLabel, ShowBubbleSizes, TextRotation, Font
    
    val - option value
  - getAxisPlacement
```
public int getAxisPlacement(int axisType)
```
    returns the Axis Label Placement or position as an int
    One of:
    Axis.INVISIBLE - axis is hidden
    Axis.LOW - low end of plot area
    Axis.HIGH - high end of plot area
    Axis.NEXTTO- next to axis (default)
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Returns:
    
    int - one of the Axis Label placement constants above
  - setAxisPlacement
```
public void setAxisPlacement(int axisType,
                             int placement)
```
    sets the axis labels position or placement to the desired value (these match Excel placement options)
    Possible options:
    Axis.INVISIBLE - hides the axis
    Axis.LOW - low end of plot area
    Axis.HIGH - high end of plot area
    Axis.NEXTTO- next to axis (default)
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    Placement - - int one of the Axis placement constants listed above
  - parseOOXML
```
public void parseOOXML(int axisType,
                       org.xmlpull.v1.XmlPullParser xpp,
                       String tnm,
                       Stack<String> lastTag,
                       WorkBookHandle bk)
```
    parse OOXML axis element
    
    Parameters:
    
    axisType - one of: XAXIS, YAXIS, ZAXIS
    
    xpp - XmlPullParser positioned at correct elemnt
    
    axisTag - catAx, valAx, serAx, dateAx
    
    lastTag - Stack of element names
  - close
```
public void close()
```
  - getMetrics
```
public HashMap getMetrics()
```
    returns already-set axisMetrics
    Used only after calling chart.getMetrics
    
    Returns:
    
    axisMetrics -- map of useful chart display metrics
    Contains:
    XAXISLABELOFFSET double XAXISTITLEOFFSET double YAXISLABELOFFSET double YAXISTITLEOFFSET double xAxisRotate integer x axis lable rotation angle yPattern string numeric pattern for y axis xPattern string numeric pattern for x axis double major; // tick units double minor;
  - getMetric
```
public Object getMetric(String metric)
```
    returns a specific axis Metric
    Use only after calling chart.getMetrics
    
    Parameters:
    
    metric - String metric option one of
    XAXISLABELOFFSET double XAXISTITLEOFFSET double YAXISLABELOFFSET double YAXISTITLEOFFSET double xAxisRotate integer x axis lable rotation angle yPattern string numeric pattern for y axis xPattern string numeric pattern for x axis double major; // tick units double minor;
    
    Returns:
  - getMetrics
```
public HashMap<String,Object> getMetrics(int charttype,
                                         HashMap<String,Double> chartMetrics,
                                         float[] plotcoords,
                                         Object[] categories)
```
    generate Axis Metrics -- minor, major scale, title and label offsets, etc. for use in SVG generation and other operations
    
    Parameters:
    
    charttype - chart type constant
    
    chartMetrics - maps chart coords in pixels x, y, w, h, canvasw, canvash, min, max
    
    plotcoords - == if set, plot-area coordinates (may not be set if automatic)
    
    Returns:
    
    axisMetrics Map: contains the important axis metrics for use in chart display

Class ChartAxes

Field Summary

Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChartAxes

Method Detail

add

setTd

hasAxis

createAxis

isReversed

getNumberFormat

removeAxes

removeAxis

getPlotAreaCoords

getPlotAreaBgColor

setPlotAreaBgColor

setPlotAreaBorder

getAxisOptionsXML

getTitle

setTitle

getLabelRotation

getTitleRotation

getCoords

getMinMax

getMinMax

getAxisMajorUnit

getAxisMinorUnit

setAxisMax

setAxisMin

setAxisAutomaticScale

getAxisAutomaticScale

getAxisAutomaticScale

setAxisAutomaticScale

setAxisMax

setAxisMin

getSVG

getOOXML

setTitleFont

getTitleFont

getLabelFont

getJSON

setChartOption

getAxisPlacement

setAxisPlacement

parseOOXML

close

getMetrics

getMetric

getMetrics