com.aspose.slides
Class Axis

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

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.
 int getCategoryAxisType()
           Specifies the type of the category 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.
 int getLabelOffset()
           Specifies the distance of labels from the 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.
 com.aspose.slides.IDOMObject getParent_Immediate()
           Returns Parent_Immediate object.
 int getPosition()
           Represents position of axis.
 IPresentation getPresentation()
           Returns the parent presentation of a FillFormat.
 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.
 IBaseSlide getSlide()
           Returns the parent slide of a FillFormat.
 boolean getSourceLinked()
          Deprecated. 
 IChartTextFormat getTextFormat()
           Represents format of text.
 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.
 boolean isAutomaticMajorUnit()
           Indicates whether the major unit of the axis is automatically assigned.
 boolean isAutomaticMaxValue()
           Indicates whether the max value is automatically assigned.
 boolean isAutomaticMinorUnit()
           Indicates whether the minor unit of the axis is automatically assigned.
 boolean isAutomaticMinValue()
           Indicates whether the min value is automatically assigned.
 boolean isAutomaticTickLabelSpacing()
           Specifies automatic tick label spacing value.
 boolean isLogarithmic()
           Represents if the value axis scale type is logarithmic or not.
 boolean isNumberFormatLinkedToSource()
           Indicates whether the format is linked source data.
 boolean isPlotOrderReversed()
           Represents if MS PowerPoint plots data points from last to first.
 boolean isVisible()
           Represents if the axis is visible.
 void setAutomaticMajorUnit(boolean value)
           Indicates whether the major unit of the axis is automatically assigned.
 void setAutomaticMaxValue(boolean value)
           Indicates whether the max value is automatically assigned.
 void setAutomaticMinorUnit(boolean value)
           Indicates whether the minor unit of the axis is automatically assigned.
 void setAutomaticMinValue(boolean value)
           Indicates whether the min value is automatically assigned.
 void setAutomaticTickLabelSpacing(boolean value)
           Specifies automatic tick label spacing value.
 void setAxisBetweenCategories(boolean value)
           Represents if the value axis crosses the category axis between categories.
 void setBaseUnitScale(int value)
           Specifies the smallest time unit that is represented on the date axis.
 void setCategoryAxisType(int value)
           Specifies the type of the category axis.
 void setCrossAt(float value)
           Represents the point on the axis where the perpendicular axis crosses it.
 void setCrossType(int value)
           Represents the CrossType on the specified axis where the other axis crosses.
 void setDisplayUnit(int value)
           Specifies the scaling value of the display units for the value axis.
 void setLabelOffset(int value)
           Specifies the distance of labels from the axis.
 void setLogarithmic(boolean value)
           Represents if the value axis scale type is logarithmic or not.
 void setLogBase(double value)
           Represents the logarithmic base.
 void setMajorTickMark(int value)
           Represents the type of major tick mark for the specified axis.
 void setMajorUnit(double value)
           Represents the major units for the date or value axis.
 void setMajorUnitScale(int value)
           Represents the major unit scale for the date axis.
 void setMaxValue(double value)
           Represents the maximum value on the value axis.
 void setMinorTickMark(int value)
           Represents the type of minor tick mark for the specified axis.
 void setMinorUnit(double value)
           Represents the minor units for the date or value axis.
 void setMinorUnitScale(int value)
           Represents the major unit scale for the date axis.
 void setMinValue(double value)
           Represents the minimum value on the value axis.
 void setNumberFormat(java.lang.String value)
           Represents the format string for the Axis Labels.
 void setNumberFormatLinkedToSource(boolean value)
           Indicates whether the format is linked source data.
 void setPlotOrderReversed(boolean value)
           Represents if MS PowerPoint plots data points from last to first.
 void setPosition(int value)
           Represents position of axis.
 void setRotationAngle(float value)
          Deprecated. 
 void setSourceLinked(boolean value)
          Deprecated. 
 void setTickLabelPosition(int value)
           Represents the position of tick-mark labels on the specified axis.
 void setTickLabelRotationAngle(float value)
           Represents the rotation angle of tick labels.
 void setTickLabelSpacing(long value)
           Specifies how many tick labels to skip between label that is drawn.
 void setTitle(boolean value)
           Determines whether a axis has a visible title.
 void setVisible(boolean value)
           Represents if the axis is visible.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getParent_Immediate

public com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.


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. This property applies only to category axes, and it doesn't apply to 3-D charts. Read/write boolean.

Specified by:
getAxisBetweenCategories in interface IAxis

setAxisBetweenCategories

public void setAxisBetweenCategories(boolean value)

Represents if the value axis crosses the category axis between categories. This property applies only to category axes, and it doesn't apply to 3-D charts. Read/write boolean.

Specified by:
setAxisBetweenCategories in interface IAxis

getCategoryAxisType

public final int getCategoryAxisType()

Specifies the type of the category axis. Read/write CategoryAxisType.

Specified by:
getCategoryAxisType in interface IAxis

setCategoryAxisType

public final void setCategoryAxisType(int value)

Specifies the type of the category axis. Read/write CategoryAxisType.

Specified by:
setCategoryAxisType in interface IAxis

getCrossAt

public float getCrossAt()

Represents the point on the axis where the perpendicular axis crosses it. Read/write float.

Specified by:
getCrossAt in interface IAxis

setCrossAt

public void setCrossAt(float value)

Represents the point on the axis where the perpendicular axis crosses it. Read/write float.

Specified by:
setCrossAt in interface IAxis

getDisplayUnit

public int getDisplayUnit()

Specifies the scaling value of the display units for the value axis. Read/write DisplayUnitType.

Specified by:
getDisplayUnit in interface IAxis

setDisplayUnit

public void setDisplayUnit(int value)

Specifies the scaling value of the display units for the value axis. Read/write DisplayUnitType.

Specified by:
setDisplayUnit in interface IAxis

isAutomaticMaxValue

public boolean isAutomaticMaxValue()

Indicates whether the max value is automatically assigned. Read/write boolean.

Specified by:
isAutomaticMaxValue in interface IAxis

setAutomaticMaxValue

public void setAutomaticMaxValue(boolean value)

Indicates whether the max value is automatically assigned. Read/write boolean.

Specified by:
setAutomaticMaxValue in interface IAxis

getMaxValue

public double getMaxValue()

Represents the maximum value on the value axis. Read/write double.

Specified by:
getMaxValue in interface IAxis

setMaxValue

public void setMaxValue(double value)

Represents the maximum value on the value axis. Read/write double.

Specified by:
setMaxValue in interface IAxis

getMinorUnit

public double getMinorUnit()

Represents the minor units for the date or value axis. Read/write double.

Specified by:
getMinorUnit in interface IAxis

setMinorUnit

public void setMinorUnit(double value)

Represents the minor units for the date or value axis. Read/write double.

Specified by:
setMinorUnit in interface IAxis

isAutomaticMinorUnit

public boolean isAutomaticMinorUnit()

Indicates whether the minor unit of the axis is automatically assigned. Read/write boolean.

Specified by:
isAutomaticMinorUnit in interface IAxis

setAutomaticMinorUnit

public void setAutomaticMinorUnit(boolean value)

Indicates whether the minor unit of the axis is automatically assigned. Read/write boolean.

Specified by:
setAutomaticMinorUnit in interface IAxis

getMajorUnit

public double getMajorUnit()

Represents the major units for the date or value axis. Read/write double.

Specified by:
getMajorUnit in interface IAxis

setMajorUnit

public void setMajorUnit(double value)

Represents the major units for the date or value axis. Read/write double.

Specified by:
setMajorUnit in interface IAxis

isAutomaticMajorUnit

public boolean isAutomaticMajorUnit()

Indicates whether the major unit of the axis is automatically assigned. Read/write boolean.

Specified by:
isAutomaticMajorUnit in interface IAxis

setAutomaticMajorUnit

public void setAutomaticMajorUnit(boolean value)

Indicates whether the major unit of the axis is automatically assigned. Read/write boolean.

Specified by:
setAutomaticMajorUnit in interface IAxis

isAutomaticMinValue

public boolean isAutomaticMinValue()

Indicates whether the min value is automatically assigned. Read/write boolean.

Specified by:
isAutomaticMinValue in interface IAxis

setAutomaticMinValue

public void setAutomaticMinValue(boolean value)

Indicates whether the min value is automatically assigned. Read/write boolean.

Specified by:
setAutomaticMinValue in interface IAxis

getMinValue

public double getMinValue()

Represents the minimum value on the value axis. Read/write double.

Specified by:
getMinValue in interface IAxis

setMinValue

public void setMinValue(double value)

Represents the minimum value on the value axis. Read/write double.

Specified by:
setMinValue in interface IAxis

isLogarithmic

public boolean isLogarithmic()

Represents if the value axis scale type is logarithmic or not. Read/write boolean.

Specified by:
isLogarithmic in interface IAxis

setLogarithmic

public void setLogarithmic(boolean value)

Represents if the value axis scale type is logarithmic or not. Read/write boolean.

Specified by:
setLogarithmic in interface IAxis

getLogBase

public double getLogBase()

Represents the logarithmic base. Default value is 10. Read/write double.

Specified by:
getLogBase in interface IAxis

setLogBase

public void setLogBase(double value)

Represents the logarithmic base. Default value is 10. Read/write double.

Specified by:
setLogBase in interface IAxis

isPlotOrderReversed

public boolean isPlotOrderReversed()

Represents if MS PowerPoint plots data points from last to first. Read/write boolean.

Specified by:
isPlotOrderReversed in interface IAxis

setPlotOrderReversed

public void setPlotOrderReversed(boolean value)

Represents if MS PowerPoint plots data points from last to first. Read/write boolean.

Specified by:
setPlotOrderReversed in interface IAxis

isVisible

public boolean isVisible()

Represents if the axis is visible. Read/write boolean.

Specified by:
isVisible in interface IAxis

setVisible

public void setVisible(boolean value)

Represents if the axis is visible. Read/write boolean.

Specified by:
setVisible in interface IAxis

getMajorTickMark

public int getMajorTickMark()

Represents the type of major tick mark for the specified axis. Read/write TickMarkType.

Specified by:
getMajorTickMark in interface IAxis

setMajorTickMark

public void setMajorTickMark(int value)

Represents the type of major tick mark for the specified axis. Read/write TickMarkType.

Specified by:
setMajorTickMark in interface IAxis

getMinorTickMark

public int getMinorTickMark()

Represents the type of minor tick mark for the specified axis. Read/write TickMarkType.

Specified by:
getMinorTickMark in interface IAxis

setMinorTickMark

public void setMinorTickMark(int value)

Represents the type of minor tick mark for the specified axis. Read/write TickMarkType.

Specified by:
setMinorTickMark in interface IAxis

getTickLabelPosition

public int getTickLabelPosition()

Represents the position of tick-mark labels on the specified axis. Read/write TickLabelPositionType.

Specified by:
getTickLabelPosition in interface IAxis

setTickLabelPosition

public void setTickLabelPosition(int value)

Represents the position of tick-mark labels on the specified axis. Read/write TickLabelPositionType.

Specified by:
setTickLabelPosition in interface IAxis

getMajorUnitScale

public int getMajorUnitScale()

Represents the major unit scale for the date axis. Read/write TimeUnitType.

Specified by:
getMajorUnitScale in interface IAxis

setMajorUnitScale

public void setMajorUnitScale(int value)

Represents the major unit scale for the date axis. Read/write TimeUnitType.

Specified by:
setMajorUnitScale in interface IAxis

getMinorUnitScale

public int getMinorUnitScale()

Represents the major unit scale for the date axis. Read/write TimeUnitType.

Specified by:
getMinorUnitScale in interface IAxis

setMinorUnitScale

public void setMinorUnitScale(int value)

Represents the major unit scale for the date axis. Read/write TimeUnitType.

Specified by:
setMinorUnitScale in interface IAxis

getBaseUnitScale

public int getBaseUnitScale()

Specifies the smallest time unit that is represented on the date axis. Read/write TimeUnitType.

Specified by:
getBaseUnitScale in interface IAxis

setBaseUnitScale

public void setBaseUnitScale(int value)

Specifies the smallest time unit that is represented on the date axis. Read/write TimeUnitType.

Specified by:
setBaseUnitScale in interface IAxis

getMinorGridLinesFormat

public IChartLinesFormat getMinorGridLinesFormat()

Represents minor gridlines format on a chart axis. Read-only IChartLinesFormat.

Specified by:
getMinorGridLinesFormat in interface IAxis

getMajorGridLinesFormat

public IChartLinesFormat getMajorGridLinesFormat()

Represents major gridlines format on a chart axis. Read-only IChartLinesFormat.

Specified by:
getMajorGridLinesFormat in interface IAxis

getShowMinorGridLines

public boolean getShowMinorGridLines()

To hide minor gridline set MinorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill. Read-only boolean.

Specified by:
getShowMinorGridLines in interface IAxis

getShowMajorGridLines

public boolean getShowMajorGridLines()

To hide major gridline set MajorGridLinesFormat.Line.FillFormat.FillType to FillType.NoFill. Read-only boolean.

Specified by:
getShowMajorGridLines in interface IAxis

getFormat

public IAxisFormat getFormat()

Represents format of axis. Read-only IAxisFormat.

Specified by:
getFormat in interface IAxis

getTextFormat

public IChartTextFormat getTextFormat()

Represents format of text. Read-only IChartTextFormat.

Specified by:
getTextFormat in interface IFormattedTextContainer

getTitle

public IChartTitle getTitle()

Gets the axis' title. Read-only IChartTitle.

Specified by:
getTitle in interface IAxis

getCrossType

public int getCrossType()

Represents the CrossType on the specified axis where the other axis crosses. Read/write CrossesType.

Specified by:
getCrossType in interface IAxis

setCrossType

public void setCrossType(int value)

Represents the CrossType on the specified axis where the other axis crosses. Read/write CrossesType.

Specified by:
setCrossType in interface IAxis

getPosition

public int getPosition()

Represents position of axis. Read/write AxisPositionType.

Specified by:
getPosition in interface IAxis

setPosition

public void setPosition(int value)

Represents position of axis. Read/write AxisPositionType.

Specified by:
setPosition in interface IAxis

hasTitle

public boolean hasTitle()

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

Specified by:
hasTitle in interface IAxis

setTitle

public void setTitle(boolean value)

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

Specified by:
setTitle in interface IAxis

getNumberFormat

public java.lang.String getNumberFormat()

Represents the format string for the Axis Labels. Read/write String.

Specified by:
getNumberFormat in interface IAxis

setNumberFormat

public void setNumberFormat(java.lang.String value)

Represents the format string for the Axis Labels. Read/write String.

Specified by:
setNumberFormat in interface IAxis

getSourceLinked

@Deprecated
public boolean getSourceLinked()
Deprecated. 

Indicates whether the format is linked source data. Read/write boolean.


setSourceLinked

@Deprecated
public void setSourceLinked(boolean value)
Deprecated. 

Indicates whether the format is linked source data. Read/write boolean.


isNumberFormatLinkedToSource

public boolean isNumberFormatLinkedToSource()

Indicates whether the format is linked source data. Read/write boolean.

Specified by:
isNumberFormatLinkedToSource in interface IAxis

setNumberFormatLinkedToSource

public void setNumberFormatLinkedToSource(boolean value)

Indicates whether the format is linked source data. Read/write boolean.

Specified by:
setNumberFormatLinkedToSource in interface IAxis

getRotationAngle

@Deprecated
public float getRotationAngle()
Deprecated. 

Represents the rotation angle of tick labels. Read/write float.


setRotationAngle

@Deprecated
public void setRotationAngle(float value)
Deprecated. 

Represents the rotation angle of tick labels. Read/write float.


getTickLabelRotationAngle

public float getTickLabelRotationAngle()

Represents the rotation angle of tick labels. Read/write float.

Specified by:
getTickLabelRotationAngle in interface IAxis

setTickLabelRotationAngle

public void setTickLabelRotationAngle(float value)

Represents the rotation angle of tick labels. Read/write float.

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. Read/write long.

Specified by:
getTickLabelSpacing in interface IAxis

setTickLabelSpacing

public void setTickLabelSpacing(long value)

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

Specified by:
setTickLabelSpacing in interface IAxis

isAutomaticTickLabelSpacing

public boolean isAutomaticTickLabelSpacing()

Specifies automatic tick label spacing value. If false: use TickLabelSpacing property. Read/write boolean.

Specified by:
isAutomaticTickLabelSpacing in interface IAxis

setAutomaticTickLabelSpacing

public void setAutomaticTickLabelSpacing(boolean value)

Specifies automatic tick label spacing value. If false: use TickLabelSpacing property. Read/write boolean.

Specified by:
setAutomaticTickLabelSpacing in interface IAxis

getLabelOffset

public int getLabelOffset()

Specifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%. Read/write ushort.

Specified by:
getLabelOffset in interface IAxis

setLabelOffset

public void setLabelOffset(int value)

Specifies the distance of labels from the axis. Applied to category or date axis. Value must be between 0% and 1000%. Read/write ushort.

Specified by:
setLabelOffset in interface IAxis

getSlide

public IBaseSlide getSlide()

Returns the parent slide of a FillFormat. Read-only BaseSlide.

Specified by:
getSlide in interface ISlideComponent

getPresentation

public IPresentation getPresentation()

Returns the parent presentation of a FillFormat. Read-only IPresentation.

Specified by:
getPresentation in interface IPresentationComponent


Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.