com.spire.xls.core.spreadsheet.charts
Class XlsChartAxis

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.charts.XlsChartAxis

All Implemented Interfaces:

IChartAxis

Direct Known Subclasses:

XlsChartCategoryAxis, XlsChartSeriesAxis, XlsChartValueAxis

public class XlsChartAxis
extends XlsObject
implements IChartAxis

Constructor Summary

XlsChartAxis(java.lang.Object parent, boolean isPrimary)

Method Summary

XlsChartAxis	deepClone(java.lang.Object parent, java.util.HashMap dicFontIndexes, java.util.HashMap dicNewSheetNames) Clone current object.
AxisTextDirectionType	getAlignment() Represents alignment for the tick label.
boolean	getAutoTickLabelSpacing()
boolean	getAutoTickMarkSpacing()
int	getAxisId() Gets axis id.
AxisType	getAxisType() Type of the axis.
ChartBorder	getBorder() Represents chart border.
IFormat3D	getChart3DOptions() Gets the chart3 D options.
IFormat3D	getChart3DProperties() Gets the chart3 D properties.
boolean	getDeleted() Gets or sets value indicating whether axis was deleted.
IFont	getFont() Returns font used for axis text displaying.
IChartFrameFormat	getFrameFormat() Return frame format of Axis.
boolean	getHas3dProperties() This property Indicates whether the Shadow object has been created(which includes the 3D properties)
IChartGridLine	getMajorGridLines() Returns major gridLines.
TickMarkType	getMajorTickMark() Represents major tick marks.
IChartGridLine	getMinorGridLines() Returns minor gridLines.
TickMarkType	getMinorTickMark() Represents minor tick marks.
boolean	getMultiLevelLable() Axis is show Multi-level category lables.
java.lang.String	getNumberFormat() Gets or sets number format string.
int	getNumberFormatIndex() Gets or sets format index.
ChartShadow	getShadow() Represents the Shadow.Read-only
IShadow	getShadowProperties() Represents Shadow Propertes.Read-Only
int	getTextRotationAngle() Text rotation angle.
TickLabelPositionType	getTickLabelPosition() Represents tick label position.
java.lang.String	getTitle() Title of the axis.
IChartTextArea	getTitleArea() Returns text area for the axis title.
boolean	getVisible() Indicates is axis is visible.
boolean	hasAxisTitle() Indicates wheather the axis has title
boolean	hasMajorGridLines() True if the axis has major gridlines.
void	hasMajorGridLines(boolean hasMajorGridLines) Sets true if the axis has major gridlines.
boolean	hasMinorGridLines() True if the axis has minor gridlines.
void	hasMinorGridLines(boolean value) True if the axis has minor gridlines.
boolean	isAutoTextRotation() Returns text area for the axis title.
boolean	isPrimary() True if this is primary axis.
boolean	isReversed() True if plots data points from last to first.
void	isReversed(boolean value) True if plots data points from last to first.
boolean	isSourceLinked()
void	isSourceLinked(boolean isSourceLinked)
void	setAlignment(AxisTextDirectionType value) Represents alignment for the tick label.
void	setAutoTickLabelSpacing(boolean value)
void	setAutoTickMarkSpacing(boolean value)
void	setAxisId(int value) Sets axis id.
void	setAxisType(AxisType value) Type of the axis.
void	setDeleted(boolean value) Gets or sets value indicating whether axis was deleted.
void	setMajorTickMark(TickMarkType majorTickMark) Sets major tick marks.
void	setMinorTickMark(TickMarkType value) Sets minor tick marks.
void	setMultiLevelLable(boolean value) Axis is show Multi-level category lables.
void	setNumberFormat(java.lang.String numberFormat) Sets number format string.
void	setNumberFormatIndex(int value) Gets or sets format index.
void	setTextRotationAngle(int value) Text rotation angle.
void	setTickLabelPosition(TickLabelPositionType tickLabelPosition) Sets tick label position.
void	setTitle(java.lang.String title) Sets title of the axis.
void	setVisible(boolean value) Indicates is axis is visible.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Constructor Detail

XlsChartAxis

public XlsChartAxis(java.lang.Object parent,
                    boolean isPrimary)

Method Detail

getAxisType

public AxisType getAxisType()

Type of the axis.

Specified by:

getAxisType in interface IChartAxis

setAxisType

public void setAxisType(AxisType value)

Type of the axis.

isPrimary

public boolean isPrimary()

True if this is primary axis.

getTitle

public java.lang.String getTitle()

Title of the axis.

Specified by:

getTitle in interface IChartAxis

setTitle

public void setTitle(java.lang.String title)

Sets title of the axis.

Specified by:

setTitle in interface IChartAxis

getTextRotationAngle

public int getTextRotationAngle()

Description copied from interface: IChartAxis

Text rotation angle. Should be integer value between -90 and 90.

Specified by:

getTextRotationAngle in interface IChartAxis

setTextRotationAngle

public void setTextRotationAngle(int value)

Description copied from interface: IChartAxis

Text rotation angle. Should be integer value between -90 and 90.

Specified by:

setTextRotationAngle in interface IChartAxis

isAutoTextRotation

public boolean isAutoTextRotation()

Returns text area for the axis title. Read-only.

getTitleArea

public IChartTextArea getTitleArea()

Returns text area for the axis title. Read-only.

Specified by:

getTitleArea in interface IChartAxis

getFont

public IFont getFont()

Returns font used for axis text displaying. Read-only.

Specified by:

getFont in interface IChartAxis

getFrameFormat

public IChartFrameFormat getFrameFormat()

Return frame format of Axis. Read-only.

getHas3dProperties

public boolean getHas3dProperties()

This property Indicates whether the Shadow object has been created(which includes the 3D properties)

hasAxisTitle

public boolean hasAxisTitle()

Indicates wheather the axis has title

getMajorGridLines

public IChartGridLine getMajorGridLines()

Returns major gridLines. Read-only.

Specified by:

getMajorGridLines in interface IChartAxis

getMinorGridLines

public IChartGridLine getMinorGridLines()

Returns minor gridLines. Read-only.

Specified by:

getMinorGridLines in interface IChartAxis

hasMinorGridLines

public boolean hasMinorGridLines()

True if the axis has minor gridlines. Only axes in the primary axis group can have gridlines.

Specified by:

hasMinorGridLines in interface IChartAxis

hasMinorGridLines

public void hasMinorGridLines(boolean value)

True if the axis has minor gridlines. Only axes in the primary axis group can have gridlines.

Specified by:

hasMinorGridLines in interface IChartAxis

hasMajorGridLines

public boolean hasMajorGridLines()

True if the axis has major gridlines. Only axes in the primary axis group can have gridlines.

Specified by:

hasMajorGridLines in interface IChartAxis

hasMajorGridLines

public void hasMajorGridLines(boolean hasMajorGridLines)

Sets true if the axis has major gridlines. Only axes in the primary axis group can have gridlines.

Specified by:

hasMajorGridLines in interface IChartAxis

getNumberFormatIndex

public int getNumberFormatIndex()

Gets or sets format index.

setNumberFormatIndex

public void setNumberFormatIndex(int value)

Gets or sets format index.

getNumberFormat

public java.lang.String getNumberFormat()

Gets or sets number format string.

Specified by:

getNumberFormat in interface IChartAxis

setNumberFormat

public void setNumberFormat(java.lang.String numberFormat)

Sets number format string.

Specified by:

setNumberFormat in interface IChartAxis

getMinorTickMark

public TickMarkType getMinorTickMark()

Represents minor tick marks.

Specified by:

getMinorTickMark in interface IChartAxis

setMinorTickMark

public void setMinorTickMark(TickMarkType value)

Sets minor tick marks.

Specified by:

setMinorTickMark in interface IChartAxis

getMajorTickMark

public TickMarkType getMajorTickMark()

Represents major tick marks.

Specified by:

getMajorTickMark in interface IChartAxis

setMajorTickMark

public void setMajorTickMark(TickMarkType majorTickMark)

Sets major tick marks.

Specified by:

setMajorTickMark in interface IChartAxis

getBorder

public ChartBorder getBorder()

Represents chart border. Read only.

Specified by:

getBorder in interface IChartAxis

getTickLabelPosition

public TickLabelPositionType getTickLabelPosition()

Represents tick label position.

Specified by:

getTickLabelPosition in interface IChartAxis

setTickLabelPosition

public void setTickLabelPosition(TickLabelPositionType tickLabelPosition)

Sets tick label position.

Specified by:

setTickLabelPosition in interface IChartAxis

getMultiLevelLable

public boolean getMultiLevelLable()

Axis is show Multi-level category lables.

setMultiLevelLable

public void setMultiLevelLable(boolean value)

Axis is show Multi-level category lables.

getVisible

public boolean getVisible()

Indicates is axis is visible.

Specified by:

getVisible in interface IChartAxis

setVisible

public void setVisible(boolean value)

Indicates is axis is visible.

Specified by:

setVisible in interface IChartAxis

getAlignment

public AxisTextDirectionType getAlignment()

Represents alignment for the tick label.

Specified by:

getAlignment in interface IChartAxis

setAlignment

public void setAlignment(AxisTextDirectionType value)

Represents alignment for the tick label.

Specified by:

setAlignment in interface IChartAxis

isReversed

public boolean isReversed()

True if plots data points from last to first.

isReversed

public void isReversed(boolean value)

True if plots data points from last to first.

getAxisId

public int getAxisId()

Gets axis id.

setAxisId

public void setAxisId(int value)

Sets axis id.

getChart3DOptions

public IFormat3D getChart3DOptions()

Gets the chart3 D options.

Specified by:

getChart3DOptions in interface IChartAxis

getChart3DProperties

public IFormat3D getChart3DProperties()

Gets the chart3 D properties.

getDeleted

public boolean getDeleted()

Gets or sets value indicating whether axis was deleted.

setDeleted

public void setDeleted(boolean value)

Gets or sets value indicating whether axis was deleted.

getShadow

public ChartShadow getShadow()

Represents the Shadow.Read-only

Specified by:

getShadow in interface IChartAxis

getShadowProperties

public IShadow getShadowProperties()

Represents Shadow Propertes.Read-Only

getAutoTickLabelSpacing

public boolean getAutoTickLabelSpacing()

setAutoTickLabelSpacing

public void setAutoTickLabelSpacing(boolean value)

getAutoTickMarkSpacing

public boolean getAutoTickMarkSpacing()

setAutoTickMarkSpacing

public void setAutoTickMarkSpacing(boolean value)

isSourceLinked

public boolean isSourceLinked()

isSourceLinked

public void isSourceLinked(boolean isSourceLinked)

deepClone

public XlsChartAxis deepClone(java.lang.Object parent,
                              java.util.HashMap dicFontIndexes,
                              java.util.HashMap dicNewSheetNames)

Clone current object.

Parameters:

parent - Parent object.

dicFontIndexes - Dictionary with new indexes.

Returns:

Returns cloned object.