com.aspose.slides
Class Axis

java.lang.Object
  extended by com.aspose.slides.Axis
All Implemented Interfaces:
IAxis, IChartComponent, IFormattedTextContainer

public class Axis
extends java.lang.Object
implements IAxis

Encapsulates the object that represents a chart's axis.


Method Summary
 boolean getAxisBetweenCategories()
           Represents if the value axis crosses the category axis between categories.
 int getBaseUnitScale()
           Specifies the smallest time unit that is represented on the date axis.
 IChart getChart()
           Returns the parent chart.
 float getCrossAt()
           Represents the point on the axis where the perpendicular axis crosses it.
 int getCrossType()
           Represents the CrossType on the specified axis where the other axis crosses.
 int getDisplayUnit()
           Specifies the scaling value of the display units for the value axis.
 IAxisFormat getFormat()
           Represents format of axis
 double getLogBase()
           Represents the logarithmic base.
 IChartLinesFormat getMajorGridLinesFormat()
           Represents major gridlines format on a chart axis.
 int getMajorTickMark()
           Represents the type of major tick mark for the specified axis.
 double getMajorUnit()
           Represents the major units for the date or value axis.
 int getMajorUnitScale()
           Represents the major unit scale for the date axis.
 double getMaxValue()
           Represents the maximum value on the value axis.
 IChartLinesFormat getMinorGridLinesFormat()
           Represents minor gridlines format on a chart axis.
 int getMinorTickMark()
           Represents the type of minor tick mark for the specified axis.
 double getMinorUnit()
           Represents the minor units for the date or value axis.
 int getMinorUnitScale()
           Represents the major unit scale for the date axis.
 double getMinValue()
           Represents the minimum value on the value axis.
 java.lang.String getNumberFormat()
           Represents the format string for the Axis Labels.
 int getPosition()
           Represents position of axis
 float getRotationAngle()
          Deprecated. 
 boolean getShowMajorGridLines()
           To hide major gridline set MajorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill.
 boolean getShowMinorGridLines()
           To hide minor gridline set MinorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill.
 boolean getSourceLinked()
          Deprecated. 
 IChartTextFormat getTextFormat()
           
 int getTickLabelPosition()
           Represents the position of tick-mark labels on the specified axis.
 float getTickLabelRotationAngle()
           Represents the rotation angle of tick labels
 long getTickLabelSpacing()
           Specifies how many tick labels to skip between label that is drawn.
 IChartTitle getTitle()
           Gets the axis' title.
 boolean hasTitle()
           Determines whether a axis has a visible title.
 void hasTitle(boolean value)
           
 boolean isAutomaticMajorUnit()
           Indicates whether the major unit of the axis is automatically assigned.
 void isAutomaticMajorUnit(boolean value)
           
 boolean isAutomaticMaxValue()
           Indicates whether the max value is automatically assigned.
 void isAutomaticMaxValue(boolean value)
           
 boolean isAutomaticMinorUnit()
           Indicates whether the minor unit of the axis is automatically assigned.
 void isAutomaticMinorUnit(boolean value)
           
 boolean isAutomaticMinValue()
           Indicates whether the min value is automatically assigned.
 void isAutomaticMinValue(boolean value)
           
 boolean isAutomaticTickLabelSpacing()
           Specifies automatic tick label spacing value.
 void isAutomaticTickLabelSpacing(boolean value)
           
 boolean isLogarithmic()
           Represents if the value axis scale type is logarithmic or not.
 void isLogarithmic(boolean value)
           
 boolean isNumberFormatLinkedToSource()
           Indicates whether the format is linked source data.
 void isNumberFormatLinkedToSource(boolean value)
           
 boolean isPlotOrderReversed()
           Represents if MS PowerPoint plots data points from last to first.
 void isPlotOrderReversed(boolean value)
           
 boolean isVisible()
           Represents if the axis is visible.
 void isVisible(boolean value)
           
 void setAxisBetweenCategories(boolean value)
           
 void setBaseUnitScale(int value)
           
 void setCrossAt(float value)
           
 void setCrossType(int value)
           
 void setDisplayUnit(int value)
           
 void setLogBase(double value)
           
 void setMajorTickMark(int value)
           
 void setMajorUnit(double value)
           
 void setMajorUnitScale(int value)
           
 void setMaxValue(double value)
           
 void setMinorTickMark(int value)
           
 void setMinorUnit(double value)
           
 void setMinorUnitScale(int value)
           
 void setMinValue(double value)
           
 void setNumberFormat(java.lang.String value)
           
 void setPosition(int value)
           
 void setRotationAngle(float value)
          Deprecated. 
 void setSourceLinked(boolean value)
          Deprecated. 
 void setTickLabelPosition(int value)
           
 void setTickLabelRotationAngle(float value)
           
 void setTickLabelSpacing(long value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getChart

public IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:
getChart in interface IChartComponent

getAxisBetweenCategories

public boolean getAxisBetweenCategories()

Represents if the value axis crosses the category axis between categories.

Specified by:
getAxisBetweenCategories in interface IAxis

setAxisBetweenCategories

public void setAxisBetweenCategories(boolean value)
Specified by:
setAxisBetweenCategories in interface IAxis

getCrossAt

public float getCrossAt()

Represents the point on the axis where the perpendicular axis crosses it.

Specified by:
getCrossAt in interface IAxis

setCrossAt

public void setCrossAt(float value)
Specified by:
setCrossAt in interface IAxis

getDisplayUnit

public int getDisplayUnit()

Specifies the scaling value of the display units for the value axis.

Specified by:
getDisplayUnit in interface IAxis

setDisplayUnit

public void setDisplayUnit(int value)
Specified by:
setDisplayUnit in interface IAxis

isAutomaticMaxValue

public boolean isAutomaticMaxValue()

Indicates whether the max value is automatically assigned.

Specified by:
isAutomaticMaxValue in interface IAxis

isAutomaticMaxValue

public void isAutomaticMaxValue(boolean value)
Specified by:
isAutomaticMaxValue in interface IAxis

getMaxValue

public double getMaxValue()

Represents the maximum value on the value axis.

Specified by:
getMaxValue in interface IAxis

setMaxValue

public void setMaxValue(double value)
Specified by:
setMaxValue in interface IAxis

getMinorUnit

public double getMinorUnit()

Represents the minor units for the date or value axis.

Specified by:
getMinorUnit in interface IAxis

setMinorUnit

public void setMinorUnit(double value)
Specified by:
setMinorUnit in interface IAxis

isAutomaticMinorUnit

public boolean isAutomaticMinorUnit()

Indicates whether the minor unit of the axis is automatically assigned.

Specified by:
isAutomaticMinorUnit in interface IAxis

isAutomaticMinorUnit

public void isAutomaticMinorUnit(boolean value)
Specified by:
isAutomaticMinorUnit in interface IAxis

getMajorUnit

public double getMajorUnit()

Represents the major units for the date or value axis.

Specified by:
getMajorUnit in interface IAxis

setMajorUnit

public void setMajorUnit(double value)
Specified by:
setMajorUnit in interface IAxis

isAutomaticMajorUnit

public boolean isAutomaticMajorUnit()

Indicates whether the major unit of the axis is automatically assigned.

Specified by:
isAutomaticMajorUnit in interface IAxis

isAutomaticMajorUnit

public void isAutomaticMajorUnit(boolean value)
Specified by:
isAutomaticMajorUnit in interface IAxis

isAutomaticMinValue

public boolean isAutomaticMinValue()

Indicates whether the min value is automatically assigned.

Specified by:
isAutomaticMinValue in interface IAxis

isAutomaticMinValue

public void isAutomaticMinValue(boolean value)
Specified by:
isAutomaticMinValue in interface IAxis

getMinValue

public double getMinValue()

Represents the minimum value on the value axis.

Specified by:
getMinValue in interface IAxis

setMinValue

public void setMinValue(double value)
Specified by:
setMinValue in interface IAxis

isLogarithmic

public boolean isLogarithmic()

Represents if the value axis scale type is logarithmic or not.

Specified by:
isLogarithmic in interface IAxis

isLogarithmic

public void isLogarithmic(boolean value)
Specified by:
isLogarithmic in interface IAxis

getLogBase

public double getLogBase()

Represents the logarithmic base. Default value is 10.

Specified by:
getLogBase in interface IAxis

setLogBase

public void setLogBase(double value)
Specified by:
setLogBase in interface IAxis

isPlotOrderReversed

public boolean isPlotOrderReversed()

Represents if MS PowerPoint plots data points from last to first.

Specified by:
isPlotOrderReversed in interface IAxis

isPlotOrderReversed

public void isPlotOrderReversed(boolean value)
Specified by:
isPlotOrderReversed in interface IAxis

isVisible

public boolean isVisible()

Represents if the axis is visible.

Specified by:
isVisible in interface IAxis

isVisible

public void isVisible(boolean value)
Specified by:
isVisible in interface IAxis

getMajorTickMark

public int getMajorTickMark()

Represents the type of major tick mark for the specified axis.

Specified by:
getMajorTickMark in interface IAxis

setMajorTickMark

public void setMajorTickMark(int value)
Specified by:
setMajorTickMark in interface IAxis

getMinorTickMark

public int getMinorTickMark()

Represents the type of minor tick mark for the specified axis.

Specified by:
getMinorTickMark in interface IAxis

setMinorTickMark

public void setMinorTickMark(int value)
Specified by:
setMinorTickMark in interface IAxis

getTickLabelPosition

public int getTickLabelPosition()

Represents the position of tick-mark labels on the specified axis.

Specified by:
getTickLabelPosition in interface IAxis

setTickLabelPosition

public void setTickLabelPosition(int value)
Specified by:
setTickLabelPosition in interface IAxis

getMajorUnitScale

public int getMajorUnitScale()

Represents the major unit scale for the date axis.

Specified by:
getMajorUnitScale in interface IAxis

setMajorUnitScale

public void setMajorUnitScale(int value)
Specified by:
setMajorUnitScale in interface IAxis

getMinorUnitScale

public int getMinorUnitScale()

Represents the major unit scale for the date axis.

Specified by:
getMinorUnitScale in interface IAxis

setMinorUnitScale

public void setMinorUnitScale(int value)
Specified by:
setMinorUnitScale in interface IAxis

getBaseUnitScale

public int getBaseUnitScale()

Specifies the smallest time unit that is represented on the date axis.

Specified by:
getBaseUnitScale in interface IAxis

setBaseUnitScale

public void setBaseUnitScale(int value)
Specified by:
setBaseUnitScale in interface IAxis

getMinorGridLinesFormat

public IChartLinesFormat getMinorGridLinesFormat()

Represents minor gridlines format on a chart axis.

Specified by:
getMinorGridLinesFormat in interface IAxis

getMajorGridLinesFormat

public IChartLinesFormat getMajorGridLinesFormat()

Represents major gridlines format on a chart axis.

Specified by:
getMajorGridLinesFormat in interface IAxis

getShowMinorGridLines

public boolean getShowMinorGridLines()

To hide minor gridline set MinorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill.

Specified by:
getShowMinorGridLines in interface IAxis

getShowMajorGridLines

public boolean getShowMajorGridLines()

To hide major gridline set MajorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill.

Specified by:
getShowMajorGridLines in interface IAxis

getFormat

public IAxisFormat getFormat()

Represents format of axis

Specified by:
getFormat in interface IAxis

getTextFormat

public IChartTextFormat getTextFormat()
Specified by:
getTextFormat in interface IFormattedTextContainer

getTitle

public IChartTitle getTitle()

Gets the axis' title.

Specified by:
getTitle in interface IAxis

getCrossType

public int getCrossType()

Represents the CrossType on the specified axis where the other axis crosses.

Specified by:
getCrossType in interface IAxis

setCrossType

public void setCrossType(int value)
Specified by:
setCrossType in interface IAxis

getPosition

public int getPosition()

Represents position of axis

Specified by:
getPosition in interface IAxis

setPosition

public void setPosition(int value)
Specified by:
setPosition in interface IAxis

hasTitle

public boolean hasTitle()

Determines whether a axis has a visible title. Read/write bool.

Specified by:
hasTitle in interface IAxis

hasTitle

public void hasTitle(boolean value)
Specified by:
hasTitle in interface IAxis

getNumberFormat

public java.lang.String getNumberFormat()

Represents the format string for the Axis Labels.

Specified by:
getNumberFormat in interface IAxis

setNumberFormat

public void setNumberFormat(java.lang.String value)
Specified by:
setNumberFormat in interface IAxis

getSourceLinked

@Deprecated
public boolean getSourceLinked()
Deprecated. 

Indicates whether the format is linked source data.


setSourceLinked

@Deprecated
public void setSourceLinked(boolean value)
Deprecated. 


isNumberFormatLinkedToSource

public boolean isNumberFormatLinkedToSource()

Indicates whether the format is linked source data.

Specified by:
isNumberFormatLinkedToSource in interface IAxis

isNumberFormatLinkedToSource

public void isNumberFormatLinkedToSource(boolean value)
Specified by:
isNumberFormatLinkedToSource in interface IAxis

getRotationAngle

@Deprecated
public float getRotationAngle()
Deprecated. 

Represents the rotation angle of tick labels


setRotationAngle

@Deprecated
public void setRotationAngle(float value)
Deprecated. 


getTickLabelRotationAngle

public float getTickLabelRotationAngle()

Represents the rotation angle of tick labels

Specified by:
getTickLabelRotationAngle in interface IAxis

setTickLabelRotationAngle

public void setTickLabelRotationAngle(float value)
Specified by:
setTickLabelRotationAngle in interface IAxis

getTickLabelSpacing

public long getTickLabelSpacing()

Specifies how many tick labels to skip between label that is drawn. Applied to category or series axis.

Specified by:
getTickLabelSpacing in interface IAxis

setTickLabelSpacing

public void setTickLabelSpacing(long value)
Specified by:
setTickLabelSpacing in interface IAxis

isAutomaticTickLabelSpacing

public boolean isAutomaticTickLabelSpacing()

Specifies automatic tick label spacing value. If false: use TickLabelSpacing property.

Specified by:
isAutomaticTickLabelSpacing in interface IAxis

isAutomaticTickLabelSpacing

public void isAutomaticTickLabelSpacing(boolean value)
Specified by:
isAutomaticTickLabelSpacing in interface IAxis