com.businessobjects.rebean.wi
Interface Graph

All Superinterfaces:

Decoration, Representation, Unit

public interface Graph
extends Representation, Decoration, Unit

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

Representation of a graph.

Method Summary

GraphAxisProperties	getAxis(GraphAxis type) Returns an object representing one of the graph's axes.
GraphData	getData() Returns an object representing the data values in the graph itself.
double	getHeight() Returns the height of the graph, in the current unit (as returned by Unit.getUnit()).
Legend	getLegend() Returns the graph's legend.
double	getPadding() Returns the padding int the current unity.
java.awt.Color	getPrimaryDataColor() Returns the primary color used to represent data.
GraphTitle	getTitle() Returns the graph's title.
java.awt.Color	getWallColor() Returns the base color for all walls.
double	getWidth() Returns the width of the graph, in the current unit (as returned by Unit.getUnit()).
boolean	is3D() Is this a three-dimensional graph or not?
boolean	is3DLook() If this graph is two-dimensional (when is3D() == false), does it have a 3D look?
boolean	isBottomWallVisible() For a 3D graph (see Graph.is3D()), is the bottom wall visible?
boolean	isLeftWallVisible() For a 3D graph (see Graph.is3D()), is the left wall visible?
boolean	isRightWallVisible() For a 3D graph (see Graph.is3D()) or a 2D graph with 3D look (see Graph.is3DLook()), is the right wall visible?
boolean	isValueInPercentage() Should the graph data be shown as a percentage?
void	set3DLook(boolean b) Gives 2D graphs a 3D look.
void	setBottomWallVisible(boolean b) For a 3D graph (see Graph.is3D()), shows or hides the bottom wall.
void	setHeight(double size) Changes the height of the graph.
void	setLeftWallVisible(boolean b) For a 3D graph (see Graph.is3D()), shows or hides the left wall.
void	setPadding(double padding) Sets the padding in the current unity.
void	setPrimaryDataColor(java.awt.Color c) Changes the primary color used to represent data.
void	setRightWallVisible(boolean b) For a 3D graph (see Graph.is3D()) or a 2D graph with 3D look (see Graph.is3DLook()), shows or hides the right wall.
void	setValueInPercentage(boolean b) Sets if the graph data be shown as a percentage.
void	setWallColor(java.awt.Color c) Changes the base color for all walls.
void	setWidth(double size) Changes the width of the graph.

Methods inherited from interface com.businessobjects.rebean.wi.Representation

getBlock, getType, setType

Methods inherited from interface com.businessobjects.rebean.wi.Decoration

getAlignment, getAttributes, getBackgroundAlignment, getFont, setAlignment, setAttributes, setBackgroundAlignment, setFont

Methods inherited from interface com.businessobjects.rebean.wi.Unit

getUnit, setUnit

Method Detail

getTitle

GraphTitle getTitle()

Returns the graph's title.

Returns:

the graph's title

getLegend

Legend getLegend()

Returns the graph's legend.

Returns:

the graph's legend

getAxis

GraphAxisProperties getAxis(GraphAxis type)

Returns an object representing one of the graph's axes.

Parameters:

type - the graph axis to get the properties for

Returns:

the properties for the requested graph axis

getData

GraphData getData()

Returns an object representing the data values in the graph itself.

Returns:

the data values' object

getWidth

double getWidth()

Returns the width of the graph, in the current unit (as returned by Unit.getUnit()).

Returns:

the width of the graph

setWidth

void setWidth(double size)

Changes the width of the graph.

Parameters:

size - the new width (in the current unit, as returned by Unit.getUnit())

Throws:

java.lang.IllegalArgumentException - when size < 0

getHeight

double getHeight()

Returns the height of the graph, in the current unit (as returned by Unit.getUnit()).

Returns:

the height of the graph

setHeight

void setHeight(double size)

Changes the height of the graph.

Parameters:

size - the new height (in the current unit, as returned by Unit.getUnit())

Throws:

java.lang.IllegalArgumentException - when size < 0

getPadding

double getPadding()

Returns the padding int the current unity. The padding of a graph is an extra empty space between the borders of the area allocated for the graph and the actual image.

Returns:

the padding

See Also:

Unit.getUnit()

setPadding

void setPadding(double padding)

Sets the padding in the current unity.

Parameters:

padding - the new padding

Throws:

java.lang.IllegalArgumentException - when padding < 0d

See Also:

Graph.getPadding()

is3DLook

boolean is3DLook()

If this graph is two-dimensional (when is3D() == false), does it have a 3D look?

Returns:

true if the graph has a 3D look

is3D

boolean is3D()

Is this a three-dimensional graph or not?

Returns:

true when this graph is three-dimensional

See Also:

GraphType.is3D()

set3DLook

void set3DLook(boolean b)

Gives 2D graphs a 3D look.

Parameters:

b - when true, the graph will have a 3D look

isValueInPercentage

boolean isValueInPercentage()

Should the graph data be shown as a percentage? Note that this applies to pie charts only.

Returns:

true when the graph data for a pie chart should be given in percentages

setValueInPercentage

void setValueInPercentage(boolean b)

Sets if the graph data be shown as a percentage. Note that this applies to pie charts only.

Parameters:

b - when true, the graph data for a pie chart will be given in percentages

isLeftWallVisible

boolean isLeftWallVisible()

For a 3D graph (see Graph.is3D()), is the left wall visible?

Returns:

true if there is a wall at the left

setLeftWallVisible

void setLeftWallVisible(boolean b)

For a 3D graph (see Graph.is3D()), shows or hides the left wall.

Parameters:

b - when true, the left wall will be visible

isRightWallVisible

boolean isRightWallVisible()

For a 3D graph (see Graph.is3D()) or a 2D graph with 3D look (see Graph.is3DLook()), is the right wall visible?

Returns:

true if there is a wall at the right

setRightWallVisible

void setRightWallVisible(boolean b)

For a 3D graph (see Graph.is3D()) or a 2D graph with 3D look (see Graph.is3DLook()), shows or hides the right wall.

Parameters:

b - when true, the right wall will be visible

isBottomWallVisible

boolean isBottomWallVisible()

For a 3D graph (see Graph.is3D()), is the bottom wall visible?

Returns:

true if there is a wall at the bottom

setBottomWallVisible

void setBottomWallVisible(boolean b)

For a 3D graph (see Graph.is3D()), shows or hides the bottom wall.

Parameters:

b - when true, the bottom wall will be visible

getWallColor

java.awt.Color getWallColor()

Returns the base color for all walls.

Returns:

the base color for all walls

setWallColor

void setWallColor(java.awt.Color c)

Changes the base color for all walls.

Parameters:

c - the new base color for all walls

getPrimaryDataColor

java.awt.Color getPrimaryDataColor()

Returns the primary color used to represent data. When this function returns null, the server's default values are used.

Returns:

the primary color

Since:

11.5

setPrimaryDataColor

void setPrimaryDataColor(java.awt.Color c)

Changes the primary color used to represent data.

Parameters:

c - the new color, or null for default value

Since:

11.5