com.businessobjects.rebean.wi
Interface GraphAxisProperties

public interface GraphAxisProperties

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

GraphAxisProperties interface represents all properties of a graph axis.

Method Summary

FormatNumber	getFormatNumber(int index) Returns the format number for the expression at index.
GraphGrid	getGrid() Returns the axis grid.
GraphTitle	getLabel() Returns the label for this axis.
int	getMarkerFrequency() Returns the marker frequency for this axis.
int	getMaxValue() Deprecated. use GraphAxisProperties.getMaxValueGraph()
double	getMaxValueGraph() Returns the maximum value for this axis.
int	getMinValue() Deprecated. use GraphAxisProperties.getMinValueGraph()
double	getMinValueGraph() Returns the minimum value for this axis.
GraphAxisValues	getValues() Returns the axis values properties.
boolean	hasMaxValue() Returns true when the value returned by GraphAxisProperties.getMaxValue() is used as the maximum value for this axis.
void	hasMaxValue(boolean b) Set to true so the value returned by GraphAxisProperties.getMaxValue() is used as the maximum value for this axis.
boolean	hasMinValue() Returns true, when the value returned by GraphAxisProperties.getMinValue() is used as the minimum value for this axis.
void	hasMinValue(boolean b) When set to true, the value returned by GraphAxisProperties.getMinValue() is used as the minimum value for this axis.
boolean	isAutoScale() checks if this axis has a auto scale option.
boolean	isCustomFormula(int index) Checks if the expression at the given index is a custom formula or not.
boolean	isLogarithmic() Checks if this axis has a logarithmic presentation.
boolean	isNumeric() Returns true, if this axis represents numeric values.
void	setAutoScale(boolean b) Change this to true to set the auto scale option, so that minimum and maximum scale value will be calculated automatically.
void	setFormatNumber(int index, FormatNumber formatNumber) Sets the format for values of the expression at index.
void	setLogarithmic(boolean b) Changes this axis's presentation to either logarithmic or linear.
void	setMarkerFrequency(int freq) Changes the marker frequency.
void	setMaxValue(int value) Deprecated. use GraphAxisProperties.setMaxValueGraph(double)
void	setMaxValueGraph(double value) Sets the maximum value for this axis.
void	setMinValue(int value) Deprecated. use GraphAxisProperties.setMinValueGraph(double)
void	setMinValueGraph(double value) Sets the minimum value for this axis.

Method Detail

isNumeric

boolean isNumeric()

Returns true, if this axis represents numeric values.

Returns:

true, if this axis represents numeric values

isLogarithmic

boolean isLogarithmic()

Checks if this axis has a logarithmic presentation.

Returns:

true, if this axis has a logarithmic presentation .

setLogarithmic

void setLogarithmic(boolean b)

Changes this axis's presentation to either logarithmic or linear.

Parameters:

b - when true, this axis will be shown in logarithmic presentation, otherwise it will be linear.

hasMinValue

boolean hasMinValue()

Returns true, when the value returned by GraphAxisProperties.getMinValue() is used as the minimum value for this axis.

Returns:

true when there is a minumum value for this axis.

hasMinValue

void hasMinValue(boolean b)

When set to true, the value returned by GraphAxisProperties.getMinValue() is used as the minimum value for this axis.

Parameters:

b - A boolean value

getMinValue

@Deprecated
int getMinValue()

Deprecated. use GraphAxisProperties.getMinValueGraph()

Returns the minimum value for this axis. Note that this value will only be taken into account when hasMinValue() == true.

Returns:

the minimum value for this axis

getMinValueGraph

double getMinValueGraph()

Returns the minimum value for this axis.

Note: this value will only be taken into account when hasMinValue() == true.

Returns:

the minimum value for this axis

Since:

11.5

setMinValue

@Deprecated
void setMinValue(int value)

Deprecated. use GraphAxisProperties.setMinValueGraph(double)

Sets the minimum value for this axis. Calling this method automatically sets GraphAxisProperties.hasMinValue() to true.

Parameters:

value - the new minimum value for this axis

setMinValueGraph

void setMinValueGraph(double value)

Sets the minimum value for this axis.

Calling this method automatically sets GraphAxisProperties.hasMinValue() to true.

Parameters:

value - the new minimum value for this axis

Since:

11.5

hasMaxValue

boolean hasMaxValue()

Returns true when the value returned by GraphAxisProperties.getMaxValue() is used as the maximum value for this axis.

Returns:

true when there is a maximum value for this axis

hasMaxValue

void hasMaxValue(boolean b)

Set to true so the value returned by GraphAxisProperties.getMaxValue() is used as the maximum value for this axis.

Parameters:

b - when true, the value returned by GraphAxisProperties.getMaxValue() will be used as the minimum value

getMaxValue

@Deprecated
int getMaxValue()

Deprecated. use GraphAxisProperties.getMaxValueGraph()

Returns the maximum value for this axis.

Note: this value will only be taken into account when hasMaxValue() == true.

Returns:

The maximum possible value for this axis.

getMaxValueGraph

double getMaxValueGraph()

Returns the maximum value for this axis.

Note: this value will only be taken into account when hasMaxValue() == true.

Returns:

the maximum value for this axis

Since:

11.5

setMaxValue

@Deprecated
void setMaxValue(int value)

Deprecated. use GraphAxisProperties.setMaxValueGraph(double)

Sets the maximum value for this axis.

Calling this method automatically sets GraphAxisProperties.hasMaxValue() to true.

Parameters:

value - the new maximum value for this axis

setMaxValueGraph

void setMaxValueGraph(double value)

Sets the maximum value for this axis.

Calling this method automatically sets GraphAxisProperties.hasMaxValue() to true.

Parameters:

value - the new maximum value for this axis

Since:

11.5

getLabel

GraphTitle getLabel()

Returns the label for this axis.

Returns:

the label for this axis

getValues

GraphAxisValues getValues()

Returns the axis values properties.

Returns:

the axis values properties

getGrid

GraphGrid getGrid()

Returns the axis grid.

Returns:

the axis grid

getMarkerFrequency

int getMarkerFrequency()

Returns the marker frequency for this axis. Possible values are:

• -1 means that all markers will be placed automatically
• 0 means no markers at all
• 1 means a marker for each value
• 2 means one marker for every two values
• 3 means one marker for every three values
• ... (etc.)

Returns:

an integer value describing how many values are needed for one marker to be shown

setMarkerFrequency

void setMarkerFrequency(int freq)

Changes the marker frequency. See getMarkerFrequency() for a description of possible values. Note that for this method, any freq < 0 will be interpreted as "determine frequency automatically."

Parameters:

freq - the new marker frequency

See Also:

GraphAxisProperties.getMarkerFrequency()

getFormatNumber

FormatNumber getFormatNumber(int index)

Returns the format number for the expression at index.

Parameters:

index - the index of the expression, as on BlockAxis.getExpr(int)

Returns:

the FormatNumber object for the requested expression, or null for the default format as defined in the universe

Throws:

java.lang.ArrayIndexOutOfBoundsException - index is not a valid index

setFormatNumber

void setFormatNumber(int index,
                     FormatNumber formatNumber)

Sets the format for values of the expression at index.

Parameters:

index - the index of the expression, as on BlockAxis.getExpr(int)

formatNumber - the new format, or null for the default format from the universe for this expression

Throws:

java.lang.ArrayIndexOutOfBoundsException - index is not a valid index

isCustomFormula

boolean isCustomFormula(int index)

Checks if the expression at the given index is a custom formula or not. An expression is custom when it is a user-created formula (see ReportDictionary.createFormula(String)) that does not evaluate to a single object. For example, =[Revenue] is not custom, but =[Revenue]*2 is.

Parameters:

index - the index of the expression to test, as on BlockAxis.getExpr(int)

Returns:

true is the expression is a custom formula

Throws:

java.lang.IndexOutOfBoundsException - index is not a valid

Since:

11.5

See Also:

TableCell.isCustomFormula(), ReportCell.isCustomFormula()

isAutoScale

boolean isAutoScale()

checks if this axis has a auto scale option.

Returns:

true, if this axis has a auto scale option.

Since:

12.2

setAutoScale

void setAutoScale(boolean b)

Change this to true to set the auto scale option, so that minimum and maximum scale value will be calculated automatically.

Parameters:

b - boolean value

Since:

12.2