com.aspose.words

Class AxisDisplayUnit

java.lang.Object

com.aspose.words.AxisDisplayUnit

All Implemented Interfaces:

java.lang.Cloneable

public class AxisDisplayUnit
extends java.lang.Object
implements java.lang.Cloneable

Provides access to the scaling options of the display units for the value axis.

To learn more, visit the Working with Charts documentation article.

Method Summary

Modifier and Type	Method and Description
double	getCustomUnit() Gets a user-defined divisor to scale display units on the value axis.
DocumentBase	getDocument() Returns the Document the title holder belongs.
ChartTitle	getTitle()
boolean	getTitleDeleted()
int	getTitlePosition()
int	getUnit() Gets the scaling value of the display units as one of the predefined values.
boolean	isVisible()
protected java.lang.Object	memberwiseClone()
void	setCustomUnit(double value) Sets a user-defined divisor to scale display units on the value axis.
void	setTitle(ChartTitle value)
void	setTitleDeleted(boolean value)
void	setUnit(int value) Sets the scaling value of the display units as one of the predefined values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUnit

public int getUnit()

Gets the scaling value of the display units as one of the predefined values. Default value is AxisBuiltInUnit.NONE. The AxisBuiltInUnit.CUSTOM and AxisBuiltInUnit.PERCENTAGE values are not available in some chart types; see AxisBuiltInUnit for more information.

Returns:

The scaling value of the display units as one of the predefined values. The returned value is one of AxisBuiltInUnit constants.

setUnit

public void setUnit(int value)

Sets the scaling value of the display units as one of the predefined values. Default value is AxisBuiltInUnit.NONE. The AxisBuiltInUnit.CUSTOM and AxisBuiltInUnit.PERCENTAGE values are not available in some chart types; see AxisBuiltInUnit for more information.

Parameters:

value - The scaling value of the display units as one of the predefined values. The value must be one of AxisBuiltInUnit constants.

getCustomUnit

public double getCustomUnit()

Gets a user-defined divisor to scale display units on the value axis.

The property is not supported by MS Office 2016 new charts. Default value is 1.

Setting this property sets the getUnit() / setUnit(int) property to AxisBuiltInUnit.CUSTOM.

Returns:

A user-defined divisor to scale display units on the value axis.

setCustomUnit

public void setCustomUnit(double value)

Sets a user-defined divisor to scale display units on the value axis.

The property is not supported by MS Office 2016 new charts. Default value is 1.

Setting this property sets the getUnit() / setUnit(int) property to AxisBuiltInUnit.CUSTOM.

Parameters:

value - A user-defined divisor to scale display units on the value axis.

getTitle

public ChartTitle getTitle()

setTitle

public void setTitle(ChartTitle value)

getTitlePosition

public int getTitlePosition()

getDocument

public DocumentBase getDocument()

Returns the Document the title holder belongs.

Returns:

The Document the title holder belongs.

getTitleDeleted

public boolean getTitleDeleted()

setTitleDeleted

public void setTitleDeleted(boolean value)

isVisible

public boolean isVisible()

memberwiseClone

protected java.lang.Object memberwiseClone()