com.spire.presentation.charts.entity
Class ChartAxis

java.lang.Object
  com.spire.presentation.PptObject
      com.spire.presentation.charts.entity.ChartAxis

All Implemented Interfaces:

IChartAxis

public class ChartAxis
extends PptObject
implements IChartAxis

Encapsulates the object that represents a chart's axis.

Constructor Summary

ChartAxis()

ChartAxis(Chart parent)

ChartAxis(DateAxis axis, Chart parent)

ChartAxis(PlotCategoryAxisData axis, Chart parent)

ChartAxis(SeriesAxis axis, Chart parent)

ChartAxis(ValueAxis axis, Chart parent)

Method Summary

AxisType	getAxisType() Gets CategoryAxis Type.
ChartBaseUnitType	getBaseUnitScale() Represents the base unit scale for the category axis.
ChartCrossesType	getChartCrossType() Represents the CrossType on the specified axis where the other axis crosses.
IChartEffectFormat	getChartEffectFormat() Represents format of axis
float	getCrossAt() Represents the point on the value axis where the category axis crosses it.
int	getCrossBetweenType() Get CrossBetweenType
ChartDisplayUnitType	getDisplayUnit() Returns or sets the unit label for the specified axis.
int	getLblOffset() Get LblOffset
int	getLogScale() Gets or sets the logarithmic base.
IChartGridLine	getMajorGridTextLines() Represents major gridlines on a chart axis.
TickMarkType	getMajorTickMark() Represents major tick marks.
float	getMajorUnit() Represents the major units for the axis.
ChartBaseUnitType	getMajorUnitScale() Represents the major unit scale for the category axis.
float	getMaxValue() Get Maximum value on axis.
IChartGridLine	getMinorGridLines() Represents minor gridlines on a chart axis.
TickMarkType	getMinorTickMark() Represents the type of minor tick mark for the specified axis.
float	getMinorUnit() Get Value of minor increment.
ChartBaseUnitType	getMinorUnitScale() Represents the major unit scale for the category axis.
float	getMinValue() Represents the minimum value on the value axis.
java.lang.String	getNumberFormat() Gets number format string.
AxisPositionType	getPosition() Represents position of axis
ITextFrameProperties	getTextProperties() Represent text properties of axis
float	getTextRotationAngle() Text rotation angle.
TickLabelPositionType	getTickLabelPosition() Represents the position of tick-mark labels on the specified axis.
long	getTickLabelSpacing() Represents the number of categories or series between tick-mark labels.
ChartTextArea	getTitle() Gets the axis' title.
boolean	hasDataSource() Indicates whether the format is linked source data.
void	hasDataSource(boolean value) Indicates whether the format is linked source data.
boolean	hasMultiLvlLbl() Get hasMultiLvlLbl.
void	hasMultiLvlLbl(boolean hasMultiLvlLbl) set hasMultiLvlLbl.
boolean	hasTitle() Indicates whether a axis has a visible title.
void	hasTitle(boolean value) Indicates whether a axis has a visible title.
boolean	isAutoMajor() Automatic major selected
void	isAutoMajor(boolean value) Automatic major selected
boolean	isAutomaticTickLabelSpacing() Specifies automatic tick label spacing value.
void	isAutomaticTickLabelSpacing(boolean value) Specifies automatic tick label spacing value.
boolean	isAutoMax() Automatic maximum selected.
void	isAutoMax(boolean value) Automatic maximum selected.
boolean	isAutoMin() Automatic minimum selected.
void	isAutoMin(boolean value) Automatic minimum selected.
boolean	isAutoMinor() Indicates whether the minor unit of the axis is automatically assigned.
void	isAutoMinor(boolean value) Indicates whether the minor unit of the axis is automatically assigned.
boolean	isCrossCategories() Indicates that the value axis crosses the category axis between categorie
void	isCrossCategories(boolean value) Set that the value axis crosses the category axis between categorie
boolean	isLogScale() Logarithmic scale.
void	isLogScale(boolean value) Logarithmic scale.
boolean	isMergeSameLabel() Get isMergeSameLabel
void	isMergeSameLabel(boolean mergeSameLabel) Set isMergeSameLabel
boolean	isReversed() Gets or set plots data points from last to first.
void	isReversed(boolean value) Gets or set plots data points from last to first.
boolean	isVisible() Gets or sets if the axis is visible.
void	isVisible(boolean value) Gets or sets if the axis is visible.
void	setAxisType(AxisType value) sets CategoryAxis Type.
void	setBaseUnitScale(ChartBaseUnitType value) Set the base unit scale for the category axis.
void	setChartCrossType(ChartCrossesType value) Sets the CrossType on the specified axis where the other axis crosses.
void	setCrossAt(float value) Set the point on the value axis where the category axis crosses it.
void	setCrossBetweenType(int value) Set CrossBetweenType
void	setDisplayUnit(ChartDisplayUnitType value) Returns or sets the unit label for the specified axis.
void	setLogScale(int value) Gets or sets the logarithmic base.
void	setMajorTickMark(TickMarkType value) Represents major tick marks.
void	setMajorUnit(float value) Set the major units for the axis.
void	setMajorUnitScale(ChartBaseUnitType value) Set the major unit scale for the category axis.
void	setMaxValue(float value) Set Maximum value on axis.
void	setMinorTickMark(TickMarkType value) Set the type of minor tick mark for the specified axis.
void	setMinorUnit(float value) Set Value of minor increment.
void	setMinorUnitScale(ChartBaseUnitType value) Set the major unit scale for the category axis.
void	setMinValue(float value) Set the minimum value on the value axis.
void	setNumberFormat(java.lang.String value) Sets number format string.
void	setPosition(AxisPositionType value) Set position of axis
void	setTextRotationAngle(float value) Text rotation angle.
void	setTickLabelPosition(TickLabelPositionType value) Set the position of tick-mark labels on the specified axis.
void	setTickLabelSpacing(long value) Set the number of categories or series between tick-mark labels.

Methods inherited from class com.spire.presentation.PptObject

checkDisposed, getParent

Methods inherited from interface com.spire.presentation.charts.entity.IChartAxis

dispose, getParent

Constructor Detail

ChartAxis

public ChartAxis()

ChartAxis

public ChartAxis(Chart parent)

ChartAxis

public ChartAxis(ValueAxis axis,
                 Chart parent)

ChartAxis

public ChartAxis(PlotCategoryAxisData axis,
                 Chart parent)

ChartAxis

public ChartAxis(SeriesAxis axis,
                 Chart parent)

ChartAxis

public ChartAxis(DateAxis axis,
                 Chart parent)

Method Detail

isMergeSameLabel

public boolean isMergeSameLabel()

Get isMergeSameLabel

Specified by:

isMergeSameLabel in interface IChartAxis

Returns:

isMergeSameLabel

public void isMergeSameLabel(boolean mergeSameLabel)

Set isMergeSameLabel

Specified by:

isMergeSameLabel in interface IChartAxis

Parameters:

mergeSameLabel -

hasMultiLvlLbl

public boolean hasMultiLvlLbl()

Get hasMultiLvlLbl.

Specified by:

hasMultiLvlLbl in interface IChartAxis

Returns:

hasMultiLvlLbl

public void hasMultiLvlLbl(boolean hasMultiLvlLbl)

set hasMultiLvlLbl.

Specified by:

hasMultiLvlLbl in interface IChartAxis

Parameters:

hasMultiLvlLbl -

isCrossCategories

public boolean isCrossCategories()

Indicates that the value axis crosses the category axis between categorie

Specified by:

isCrossCategories in interface IChartAxis

Returns:

isCrossCategories

public void isCrossCategories(boolean value)

Description copied from interface: IChartAxis

Set that the value axis crosses the category axis between categorie

Specified by:

isCrossCategories in interface IChartAxis

getCrossAt

public float getCrossAt()

Represents the point on the value axis where the category axis crosses it.

Specified by:

getCrossAt in interface IChartAxis

Returns:

setCrossAt

public void setCrossAt(float value)

Description copied from interface: IChartAxis

Set the point on the value axis where the category axis crosses it. The number should be a integer when it applies to category axis. And the value must be between 1 and 31999.

Specified by:

setCrossAt in interface IChartAxis

getDisplayUnit

public ChartDisplayUnitType getDisplayUnit()

Returns or sets the unit label for the specified axis.

Specified by:

getDisplayUnit in interface IChartAxis

Returns:

setDisplayUnit

public void setDisplayUnit(ChartDisplayUnitType value)

Returns or sets the unit label for the specified axis.

Specified by:

setDisplayUnit in interface IChartAxis

Parameters:

value -

isAutoMax

public boolean isAutoMax()

Automatic maximum selected.

Specified by:

isAutoMax in interface IChartAxis

Returns:

isAutoMax

public void isAutoMax(boolean value)

Automatic maximum selected.

Specified by:

isAutoMax in interface IChartAxis

Parameters:

value -

getMaxValue

public float getMaxValue()

Get Maximum value on axis.

Specified by:

getMaxValue in interface IChartAxis

Returns:

setMaxValue

public void setMaxValue(float value)

Set Maximum value on axis.

Specified by:

setMaxValue in interface IChartAxis

Parameters:

value -

getMinorUnit

public float getMinorUnit()

Get Value of minor increment.

Specified by:

getMinorUnit in interface IChartAxis

Returns:

setMinorUnit

public void setMinorUnit(float value)

Set Value of minor increment.

Specified by:

setMinorUnit in interface IChartAxis

Parameters:

value -

isAutoMinor

public boolean isAutoMinor()

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

Specified by:

isAutoMinor in interface IChartAxis

Returns:

isAutoMinor

public void isAutoMinor(boolean value)

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

Specified by:

isAutoMinor in interface IChartAxis

Parameters:

value -

getMajorUnit

public float getMajorUnit()

Represents the major units for the axis.

Specified by:

getMajorUnit in interface IChartAxis

Returns:

setMajorUnit

public void setMajorUnit(float value)

Set the major units for the axis.

Specified by:

setMajorUnit in interface IChartAxis

Parameters:

value -

isAutoMajor

public boolean isAutoMajor()

Automatic major selected

Specified by:

isAutoMajor in interface IChartAxis

Returns:

isAutoMajor

public void isAutoMajor(boolean value)

Automatic major selected

Specified by:

isAutoMajor in interface IChartAxis

isAutoMin

public boolean isAutoMin()

Automatic minimum selected.

Specified by:

isAutoMin in interface IChartAxis

Returns:

isAutoMin

public void isAutoMin(boolean value)

Automatic minimum selected.

Specified by:

isAutoMin in interface IChartAxis

getMinValue

public float getMinValue()

Represents the minimum value on the value axis.

Specified by:

getMinValue in interface IChartAxis

Returns:

setMinValue

public void setMinValue(float value)

Set the minimum value on the value axis.

Specified by:

setMinValue in interface IChartAxis

Parameters:

value -

isLogScale

public boolean isLogScale()

Logarithmic scale.

Specified by:

isLogScale in interface IChartAxis

Returns:

isLogScale

public void isLogScale(boolean value)

Logarithmic scale.

Specified by:

isLogScale in interface IChartAxis

Parameters:

value -

getLogScale

public int getLogScale()

Gets or sets the logarithmic base.

Specified by:

getLogScale in interface IChartAxis

Returns:

setLogScale

public void setLogScale(int value)

Gets or sets the logarithmic base.

Specified by:

setLogScale in interface IChartAxis

Parameters:

value -

isReversed

public boolean isReversed()

Gets or set plots data points from last to first.

Specified by:

isReversed in interface IChartAxis

Returns:

isReversed

public void isReversed(boolean value)

Gets or set plots data points from last to first.

Specified by:

isReversed in interface IChartAxis

Parameters:

value -

isVisible

public boolean isVisible()

Gets or sets if the axis is visible.

Specified by:

isVisible in interface IChartAxis

Returns:

isVisible

public void isVisible(boolean value)

Gets or sets if the axis is visible.

Specified by:

isVisible in interface IChartAxis

Parameters:

value -

getMajorTickMark

public TickMarkType getMajorTickMark()

Represents major tick marks.

Specified by:

getMajorTickMark in interface IChartAxis

Returns:

setMajorTickMark

public void setMajorTickMark(TickMarkType value)

Represents major tick marks.

Specified by:

setMajorTickMark in interface IChartAxis

Parameters:

value -

getMinorTickMark

public TickMarkType getMinorTickMark()

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

Specified by:

getMinorTickMark in interface IChartAxis

Returns:

setMinorTickMark

public void setMinorTickMark(TickMarkType value)

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

Specified by:

setMinorTickMark in interface IChartAxis

Parameters:

value -

getTickLabelPosition

public TickLabelPositionType getTickLabelPosition()

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

Specified by:

getTickLabelPosition in interface IChartAxis

Returns:

setTickLabelPosition

public void setTickLabelPosition(TickLabelPositionType value)

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

Specified by:

setTickLabelPosition in interface IChartAxis

Parameters:

value -

getMajorUnitScale

public ChartBaseUnitType getMajorUnitScale()

Represents the major unit scale for the category axis.

Specified by:

getMajorUnitScale in interface IChartAxis

Returns:

setMajorUnitScale

public void setMajorUnitScale(ChartBaseUnitType value)

Set the major unit scale for the category axis.

Specified by:

setMajorUnitScale in interface IChartAxis

Parameters:

value -

getMinorUnitScale

public ChartBaseUnitType getMinorUnitScale()

Represents the major unit scale for the category axis.

Specified by:

getMinorUnitScale in interface IChartAxis

Returns:

setMinorUnitScale

public void setMinorUnitScale(ChartBaseUnitType value)

Set the major unit scale for the category axis.

Specified by:

setMinorUnitScale in interface IChartAxis

Parameters:

value -

getBaseUnitScale

public ChartBaseUnitType getBaseUnitScale()

Represents the base unit scale for the category axis.

Specified by:

getBaseUnitScale in interface IChartAxis

Returns:

setBaseUnitScale

public void setBaseUnitScale(ChartBaseUnitType value)

Set the base unit scale for the category axis.

Specified by:

setBaseUnitScale in interface IChartAxis

Parameters:

value -

getMinorGridLines

public IChartGridLine getMinorGridLines()

Represents minor gridlines on a chart axis.

Specified by:

getMinorGridLines in interface IChartAxis

Returns:

getMajorGridTextLines

public IChartGridLine getMajorGridTextLines()

Represents major gridlines on a chart axis.

Specified by:

getMajorGridTextLines in interface IChartAxis

Returns:

getChartEffectFormat

public IChartEffectFormat getChartEffectFormat()

Represents format of axis

Specified by:

getChartEffectFormat in interface IChartAxis

Returns:

getTextProperties

public ITextFrameProperties getTextProperties()

Represent text properties of axis

Specified by:

getTextProperties in interface IChartAxis

Returns:

getTitle

public ChartTextArea getTitle()

Gets the axis' title.

Specified by:

getTitle in interface IChartAxis

Returns:

getChartCrossType

public ChartCrossesType getChartCrossType()

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

Specified by:

getChartCrossType in interface IChartAxis

Returns:

setChartCrossType

public void setChartCrossType(ChartCrossesType value)

Description copied from interface: IChartAxis

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

Specified by:

setChartCrossType in interface IChartAxis

getPosition

public AxisPositionType getPosition()

Represents position of axis

Specified by:

getPosition in interface IChartAxis

Returns:

setPosition

public void setPosition(AxisPositionType value)

Set position of axis

Specified by:

setPosition in interface IChartAxis

Parameters:

value -

hasTitle

public boolean hasTitle()

Indicates whether a axis has a visible title. Read/write .

Specified by:

hasTitle in interface IChartAxis

Returns:

hasTitle

public void hasTitle(boolean value)

Indicates whether a axis has a visible title. Read/write .

Specified by:

hasTitle in interface IChartAxis

getCrossBetweenType

public int getCrossBetweenType()

Get CrossBetweenType

Specified by:

getCrossBetweenType in interface IChartAxis

Returns:

setCrossBetweenType

public void setCrossBetweenType(int value)

Set CrossBetweenType

Specified by:

setCrossBetweenType in interface IChartAxis

getNumberFormat

public java.lang.String getNumberFormat()

Gets number format string.

Specified by:

getNumberFormat in interface IChartAxis

Returns:

setNumberFormat

public void setNumberFormat(java.lang.String value)

Sets number format string.

Specified by:

setNumberFormat in interface IChartAxis

Parameters:

value -

hasDataSource

public boolean hasDataSource()

Indicates whether the format is linked source data.

Specified by:

hasDataSource in interface IChartAxis

Returns:

hasDataSource

public void hasDataSource(boolean value)

Indicates whether the format is linked source data.

Specified by:

hasDataSource in interface IChartAxis

Parameters:

value -

getTextRotationAngle

public float getTextRotationAngle()

Text rotation angle.

Specified by:

getTextRotationAngle in interface IChartAxis

Returns:

setTextRotationAngle

public void setTextRotationAngle(float value)

Text rotation angle.

Specified by:

setTextRotationAngle in interface IChartAxis

Parameters:

value -

getTickLabelSpacing

public long getTickLabelSpacing()

Represents the number of categories or series between tick-mark labels.

Specified by:

getTickLabelSpacing in interface IChartAxis

Returns:

setTickLabelSpacing

public void setTickLabelSpacing(long value)

Set the number of categories or series between tick-mark labels.

Specified by:

setTickLabelSpacing in interface IChartAxis

Parameters:

value -

isAutomaticTickLabelSpacing

public boolean isAutomaticTickLabelSpacing()

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

Specified by:

isAutomaticTickLabelSpacing in interface IChartAxis

Returns:

isAutomaticTickLabelSpacing

public void isAutomaticTickLabelSpacing(boolean value)

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

Specified by:

isAutomaticTickLabelSpacing in interface IChartAxis

Parameters:

value -

getLblOffset

public int getLblOffset()

Get LblOffset

Returns:

getAxisType

public AxisType getAxisType()

Description copied from interface: IChartAxis

Gets CategoryAxis Type.

Specified by:

getAxisType in interface IChartAxis

Returns:

setAxisType

public void setAxisType(AxisType value)

Description copied from interface: IChartAxis

sets CategoryAxis Type.

Specified by:

setAxisType in interface IChartAxis