Web
Dynpro BusinessGraphics API - IWDBusinessGraphics 
Definition
The BusinessGraphics UI element provides several chart types such as vertical bar charts or pie charts, that can be used for the graphical illustration of data and data relationships. In addition, there are more complex chart types such as portfolio and gantt that can help the user of your Web application to make decisions for corporate planning or find information in general.
You can use the
Chart Designer to modify the UI element properties and additional
properties, the chart elements, and adapt them to suit your requirements. For
detailed information on this tool, refer to
For further information about the chart types like the three-dimensional pie chart below and detailed documentation about Internet Graphics Service (IGS), refer to the SAP library under SAP NetWeaver ® Application Platform (SAP Web Application Server) ® ABAP Technology ®UI Technology ®Frontend Services.
Use
When using a business graphic, always display this UI element alongside a Label UI element to ensure accessibiltiy.
Description of the UI Element Properties
·
backgroundColor
Specifies the background
color of a BusinessGraphics UI element.
·
chartType
Specifies the chart type. The
following chart types are available:
Chart Type |
Short Description |
Example |
area |
Describes a surface diagram. |
|
bars |
Describes a bar chart. |
|
columns |
Describes a vertical bar chart. |
|
doughnut |
Describes a ring chart. |
|
gantt |
Describes a chart of the type Gantt. |
|
lines |
Describes a line chart. |
|
pie |
Describes a pie chart. |
|
pipeline |
Describes a chart of the type pipeline. |
|
polar |
Describes a chart of the type polar. |
|
portfolio |
Describes a chart of the type portfolio. This chart type can be used as an analytical means in the strategic corporate planning because it can illustrate the competitiveness, for example. |
|
profile_area |
Describes a chart of the type profile_area. |
|
profiles |
Describes a chart of the type profiles. |
|
radar |
Describes a chart of the type radar. |
|
scatter |
Describes a chart of the type scatter. |
|
speedometer |
Describes a chart of the type speedometer. |
|
split_pie |
Describes a chart of the type split_pie. |
|
stacked_area |
Describes a chart of the type stacked_area. |
|
stacked_bars |
Describes a chart of the type stacked_bars. |
|
stacked_columns |
Describes a chart of the type stacked_columns. |
|
stacked_lines |
Describes a chart of the type stacked_lines. |
|
stacked_profile_area |
Describes a chart of the type stacked_profile_area. |
|
stacked_profiles |
Describes a chart of the type stacked_profiles. |
|
stacked_radar |
Describes a chart of the type stacked_radar. |
|
·
customizing
Describes how the chart is
displayed on the screen. This property is assigned to a Web address (URL)
linking to an XML file that describes the appearance of the business graphic
on the screen – for example, the graphic color, the background color,
fonts, and so on. It also specifies whether the graphic displays a legend or
not. You can specify these settings directly in the SAP NetWeaver Developer
Studio using theChart Designer tool. To call the tool, place the cursor
on the UI element, click the right mouse button, and select the Start Chart
Designer menu option in the context menu.
The BusinessGraphics properties dimensionand fontFamily are provided by the meta model itself. They
overwrite the Customizing settings if they differ from meta model settings.
·
seriesSource
Describes the path to the
context node in the hierarchical structure of the context that provides the
data.
·
dimension
Describes the dimensions of
the chart. The following dimensions are available:
pseudo_three |
A pseudo-three-dimensional chart, the z-axis is not displayed. |
three |
A real three-dimensional chart. |
two |
A two-dimensional chart (surface diagram). |
·
fontFamily
Specifies the font for the
graphic elements.
·
height
Specifies the height of the
chart and can be specified in relative CSS units like em, ex, or
percentage.
·
igsUrl
This property can specify the
Web address (URL) of the server on which the Internet Graphics Service should
run. This means that you can overwrite the global URL for which the
Web Dynpro System
Configuration in the
default.properties file has been set.
·
transparentColor
Specifies the color to be
used as transparent color. You can specify the colors in RGB, HSB, or X11 -
for example, rgb(255,0,0), or slateblue.
·
width
Specifies the width of the
chart and can be specified in relative CSS units like em, ex, or
percentage.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
backgroundColor |
IWDBusinessGraphics |
String |
|
not_bindable |
No |
chartType |
IWDBusinessGraphics |
WDBusinessGraphicsType |
columns |
not_bindable |
No |
customizing |
IWDBusinessGraphics |
String |
|
not_bindable |
No |
seriesSource |
IWDBusinessGraphics |
Object |
|
bindable_mandatory |
No |
dimension |
IWDBusinessGraphics |
WDBusinessGraphicsDimension |
two |
not_bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
fontFamiliy |
IWDBusinessGraphics |
String |
|
not_bindable |
No |
height |
IWDBusinessGraphics |
String |
300 |
not_bindable |
No |
igsUrl |
IWDBusinessGraphics |
String |
|
not_bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
transparentColor |
IWDBusinessGraphics |
String |
|
not_bindable |
No |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDBusinessGraphics |
String |
300 |
not_bindable |
No |
Events
·
onAction
Describes the action to be
executed when the user selects a certain area of the business
graphic.
Event Parameter |
Type |
ID |
String |
For further information, refer to Event Parameter and Parameter Mapping.
Data Binding
See Data Binding of BusinessGraphics UI
Elements.
Methods of the Web Dynpro IWDBusinessGraphics API
Method Name |
Parameter |
Return Value |
Description |
addSeries |
(IWDAbstractSeries series) |
|
Adds a Series element at the end of the Series elements list. |
addSeries |
(IWDAbstractSeries series, int index) |
|
Adds a Series element at the specified index position of the Series elements list. |
bindingOfSeriesSource |
|
String |
Returns the path of the context element to which the seriesSource property is bound. Returns NULL if no binding exists. |
bindSeriesSource |
(String path) |
|
Binds the seriesSource property to the context node specified by a path. |
destroyAllSeriesList |
|
|
Removes all Series elements. These are destroyed and no longer exist, so that the associated IDs can be used for new elements. |
destroyCategory |
|
|
Removes and deletes the category for this BusinessGraphics element. |
getBackgroundColor |
|
String |
Returns the value of the backgroundColor property. |
getCategory |
|
IWDCategory |
Returns the category for this BusinessGraphics element. |
getChartType |
|
WDBusinessGraphicsType |
Returns the value of the chartType property. |
getCustomizing |
|
String |
Returns the value of the customizing property. |
getDimension |
|
WDBusinessGraphicsDimension |
Returns the value of the dimension property. |
getFontFamily |
|
String |
Returns the value of the fontFamily property. |
getHeight |
|
int |
Returns the value of the height property. |
getIgsUrl |
|
String |
Returns the value of the igsUrl property. |
getOnAction |
|
IWDAction |
Returns the action that is executed when the onAction event is triggered. |
getSeriesList |
|
IWDAbstractSeries[] |
Returns an array of the Series elements. |
getTransparentColor |
|
String |
Returns the value of the transparentColor property. |
getWidth |
|
int |
Returns the value of the width property. |
hasSeriesList |
|
boolean |
Checks whether or not Series elements exist in this BusinessGraphics element. |
iterateSeriesList |
|
Iterator |
Returns an iterator about all Series elements in this BusinessGraphics element. |
mappingOfOnAction |
|
IWDParameterMapping |
Returns the parameter mapping for the onAction action. |
numberOfSeriesList |
|
int |
Returns the number of the Series elements. |
removeAllSeriesList |
|
|
Removes all Series elements. They remain and can be added to this BusinessGraphics element. |
removeSeries |
(int index) |
IWDAbstractSeries |
Removes the Series element at the specified index position. |
removeSeries |
(String id) |
IWDAbstractSeries |
Removes the Series element with the specified ID. |
setBackgroundColor |
(String backgroundColor) |
|
Sets the value of the backgroundColor property. |
setCategory |
(IWDCategory category) |
|
Sets the category for this BusinessGraphics element. |
setChartType |
(WDBusinessGraphicsType chartType) |
|
Sets the value of the chartType property. |
setCustomizing |
(String customizing) |
|
Sets the value of the customizing property. |
setDimension |
(WDBusinessGraphicsDimension dimension) |
|
Sets the value of the dimension property. |
setFontFamily |
(String fontFamily) |
|
Sets the value of the fontFamily property. |
setHeight |
(int height) |
|
Sets the value of the height property. |
setIgsUrl |
(String igsUrl) |
|
Sets the value of the igsUrl property. |
setOnAction |
(IWDAction action) |
|
Sets the action that is executed if the onAction event is raised. |
setTransparentColor |
(String transparentColor) |
|
Sets the value of the transparentColor property. |
setWidth |
(int width) |
|
Sets the value of the width property. |
Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.
The relationships to the associated APIs are explained under Meta Model of the BusinessGraphics UI Element.
Associated Interfaces