com.spire.presentation.charts.entity
Interface IChartAxis

All Known Implementing Classes:

ChartAxis

public interface IChartAxis

Represents a chart axis.

Method Summary

void	dispose() Dispose object and free resources.
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() Gets CrossBetweenType
ChartDisplayUnitType	getDisplayUnit() Returns or sets the unit label for the specified axis.
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() 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() 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 or sets number format string.
java.lang.Object	getParent() Reference to Parent object.
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) Sets 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) Sets whether a axis has a visible title.
boolean	isAutoMajor() Automatic major selected.
void	isAutoMajor(boolean value) Set Automatic major selected.
boolean	isAutomaticTickLabelSpacing() Represents the number of categories or series between tick-mark labels.
void	isAutomaticTickLabelSpacing(boolean value) Sets the number of categories or series between tick-mark labels.
boolean	isAutoMax() Automatic maximum selected.
void	isAutoMax(boolean value) Set Automatic maximum selected.
boolean	isAutoMin() Automatic minimum selected.
void	isAutoMin(boolean value) Set Automatic minimum selected.
boolean	isAutoMinor() Indicates whether the minor unit of the axis is automatically assigned.
void	isAutoMinor(boolean value) Set 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) Set 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) Sets 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) Set 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) Gets or sets number format string.
void	setPosition(AxisPositionType value)
void	setTextRotationAngle(float value) Sets Text rotation angle.
void	setTickLabelPosition(TickLabelPositionType value) Set the position of tick-mark labels on the specified axis.
void	setTickLabelSpacing(long value) Sets the number of categories or series between tick-mark labels.

Method Detail

isCrossCategories

boolean isCrossCategories()

Indicates that the value axis crosses the category axis between categorie

Returns:

isCrossCategories

void isCrossCategories(boolean value)

Set that the value axis crosses the category axis between categorie

Parameters:

value -

getCrossAt

float getCrossAt()

Represents 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.

Returns:

setCrossAt

void setCrossAt(float value)

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.

Parameters:

value -

getDisplayUnit

ChartDisplayUnitType getDisplayUnit()

Returns or sets the unit label for the specified axis.

Returns:

setDisplayUnit

void setDisplayUnit(ChartDisplayUnitType value)

Returns or sets the unit label for the specified axis.

Parameters:

value -

isAutoMax

boolean isAutoMax()

Automatic maximum selected.

Returns:

isAutoMax

void isAutoMax(boolean value)

Set Automatic maximum selected.

Parameters:

value -

getMaxValue

float getMaxValue()

Maximum value on axis.

Returns:

setMaxValue

void setMaxValue(float value)

Set Maximum value on axis.

Parameters:

value -

getMinorUnit

float getMinorUnit()

Value of minor increment.

Returns:

setMinorUnit

void setMinorUnit(float value)

Set Value of minor increment.

Parameters:

value -

isAutoMinor

boolean isAutoMinor()

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

Returns:

isAutoMinor

void isAutoMinor(boolean value)

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

Parameters:

value -

getMajorUnit

float getMajorUnit()

Represents the major units for the axis.

Returns:

setMajorUnit

void setMajorUnit(float value)

Set the major units for the axis.

Parameters:

value -

isAutoMajor

boolean isAutoMajor()

Automatic major selected.

Returns:

isAutoMajor

void isAutoMajor(boolean value)

Set Automatic major selected.

Parameters:

value -

isAutoMin

boolean isAutoMin()

Automatic minimum selected.

Returns:

isAutoMin

void isAutoMin(boolean value)

Set Automatic minimum selected.

Parameters:

value -

getMinValue

float getMinValue()

Represents the minimum value on the value axis.

Returns:

setMinValue

void setMinValue(float value)

Set the minimum value on the value axis.

Parameters:

value -

isLogScale

boolean isLogScale()

Logarithmic scale.

Returns:

isLogScale

void isLogScale(boolean value)

Set Logarithmic scale.

Parameters:

value -

getLogScale

int getLogScale()

Gets or sets the logarithmic base.

Returns:

setLogScale

void setLogScale(int value)

Gets or sets the logarithmic base.

Parameters:

value -

isReversed

boolean isReversed()

Gets or set plots data points from last to first.

Returns:

isReversed

void isReversed(boolean value)

Gets or set plots data points from last to first.

Parameters:

value -

isVisible

boolean isVisible()

Gets or sets if the axis is visible.

Returns:

isVisible

void isVisible(boolean value)

Gets or sets if the axis is visible.

Parameters:

value -

getMajorTickMark

TickMarkType getMajorTickMark()

Represents major tick marks.

Returns:

setMajorTickMark

void setMajorTickMark(TickMarkType value)

Set major tick marks.

Parameters:

value -

getMinorTickMark

TickMarkType getMinorTickMark()

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

Returns:

setMinorTickMark

void setMinorTickMark(TickMarkType value)

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

Parameters:

value -

getTickLabelPosition

TickLabelPositionType getTickLabelPosition()

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

Returns:

setTickLabelPosition

void setTickLabelPosition(TickLabelPositionType value)

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

Parameters:

value -

getMajorUnitScale

ChartBaseUnitType getMajorUnitScale()

Represents the major unit scale for the category axis.

Returns:

setMajorUnitScale

void setMajorUnitScale(ChartBaseUnitType value)

Set the major unit scale for the category axis.

Parameters:

value -

getMinorUnitScale

ChartBaseUnitType getMinorUnitScale()

Represents the major unit scale for the category axis.

Returns:

setMinorUnitScale

void setMinorUnitScale(ChartBaseUnitType value)

Set the major unit scale for the category axis.

Parameters:

value -

getBaseUnitScale

ChartBaseUnitType getBaseUnitScale()

Represents the base unit scale for the category axis.

Returns:

setBaseUnitScale

void setBaseUnitScale(ChartBaseUnitType value)

Set the base unit scale for the category axis.

Parameters:

value -

getMinorGridLines

IChartGridLine getMinorGridLines()

Represents minor gridlines on a chart axis.

Returns:

getMajorGridTextLines

IChartGridLine getMajorGridTextLines()

Represents major gridlines on a chart axis.

Returns:

getChartEffectFormat

IChartEffectFormat getChartEffectFormat()

Represents format of axis

Returns:

getTextProperties

ITextFrameProperties getTextProperties()

Represent text properties of axis

Returns:

getTitle

ChartTextArea getTitle()

Gets the axis' title.

Returns:

getChartCrossType

ChartCrossesType getChartCrossType()

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

Returns:

setChartCrossType

void setChartCrossType(ChartCrossesType value)

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

Parameters:

value -

getPosition

AxisPositionType getPosition()

Represents position of axis

Returns:

setPosition

void setPosition(AxisPositionType value)

hasTitle

boolean hasTitle()

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

Returns:

hasTitle

void hasTitle(boolean value)

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

Parameters:

value -

getNumberFormat

java.lang.String getNumberFormat()

Gets or sets number format string.

Returns:

setNumberFormat

void setNumberFormat(java.lang.String value)

Gets or sets number format string.

Parameters:

value -

hasDataSource

boolean hasDataSource()

Indicates whether the format is linked source data.

Returns:

hasDataSource

void hasDataSource(boolean value)

Sets whether the format is linked source data.

Parameters:

value -

getTextRotationAngle

float getTextRotationAngle()

Text rotation angle.

Returns:

setTextRotationAngle

void setTextRotationAngle(float value)

Sets Text rotation angle.

Parameters:

value -

getTickLabelSpacing

long getTickLabelSpacing()

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

Returns:

setTickLabelSpacing

void setTickLabelSpacing(long value)

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

Parameters:

value -

getParent

java.lang.Object getParent()

Reference to Parent object. Read-only.

Returns:

dispose

void dispose()

Dispose object and free resources.

isAutomaticTickLabelSpacing

boolean isAutomaticTickLabelSpacing()

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

Returns:

isAutomaticTickLabelSpacing

void isAutomaticTickLabelSpacing(boolean value)

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

Parameters:

value -

getCrossBetweenType

int getCrossBetweenType()

Gets CrossBetweenType

Returns:

setCrossBetweenType

void setCrossBetweenType(int value)

Sets CrossBetweenType

Parameters:

value -

setAxisType

void setAxisType(AxisType value)

sets CategoryAxis Type.

getAxisType

AxisType getAxisType()

Gets CategoryAxis Type.

Returns:

isMergeSameLabel

boolean isMergeSameLabel()

Get isMergeSameLabel

Returns:

isMergeSameLabel

void isMergeSameLabel(boolean mergeSameLabel)

Set isMergeSameLabel

Parameters:

mergeSameLabel -

hasMultiLvlLbl

boolean hasMultiLvlLbl()

Get hasMultiLvlLbl.

Returns:

hasMultiLvlLbl

void hasMultiLvlLbl(boolean hasMultiLvlLbl)

set hasMultiLvlLbl.

Parameters:

hasMultiLvlLbl -