Web Dynpro Category API - IWDCategory 

Overview

The Category object is a part the BusinessGraphics UI Elementand describes the categories of a graphical representation. Categories of a chart are a discrete value range or an unsorted set of objects - such as January, February, March, and so on - that do not have a distance term and therefore have no relation to each other. In a vertical bar chart, the categories are displayed next to each other in columns with the categories on the x-axis and the values on the y-axis. This enables the user to compare individual categories – for example, the sales figures for each month of one year.

The following chart shows a business graphic of the vertical bar chart type with six categories and three data series. The six categories are displayed on the horizontal x-axis. The three data series are displayed as vertical columns for each category.

For example, the categories of a chart can represent the first six months, and each data series can represent a pharmaceutical company. The height of an individual column can indicate the revenue of a company in one month.

Unlike the simple category-based charts such as vertical bar charts, the more complex scatter charts and portfolio charts do not contain categories.

A pie chart represents all categories of a data series.

Property Descriptions

·        description
Specifies the texts of the categories. You can statically specify this property value at design time or bind it to a context attribute so that the value is provided automatically by the context at runtime.

·        eventID
Enables you to define an ID that can determine from which object the event has been triggered.

·        tooltip
Describes a note for the UI element that is displayed when the user places the cursor on the UI element.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
description	IWDCategory	String	No	bindable_mandatory	No
eventID	IWDCategory	String		bindable	No
tooltip	IWDCategory	String (TranslatableText)	No	bindable	No

Events

·        onAction
This property can be used to execute a predefined Web Dynpro action when selecting the category area in the generated graphic.

Methods in the Web Dynpro IWDCategory API

Method Name	Parameter	Return Value	Short Description
bindDescription	(String path)		Binds the value of the description property to the context element specified by the path.
bindEventID	(String path)		Binds the eventID property to the context node specified by a path.
bindingOfDescription		String	Returns the path of the context element to which the description property is bound. Returns NULL if no binding exists.
bindingOfEventID		String	Returns the path of the context element to which the eventID property is bound. Returns NULL if no binding exists.
bindingOfTooltip		String	Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists.
bindTooltip	(String path)		Binds the value of the tooltip property to the context element specified by the path.
getBusinessGraphics		IWDBusinessGraphics	Returns the BusinessGraphics element in which this Category element is contained.
getDescription		String	Returns the value of the description property.
getEventID		String	Returns the value of the eventID property.
getOnAction		IWDAction	Returns the action that is executed when the onAction event is triggered.
getTooltip		String	Returns the value of the tooltip property.
mappingOfOnAction		IWDParameterMapping	Returns the parameter mapping for the onAction action.
setDescription	(String value)		Sets the value of the description property.
setEventID	(String eventID)		Sets the value of the eventID property.
setOnAction	(IWDAction action)		Sets the action that is executed if the onAction event is raised.
setTooltip	(String value)		Sets the value of the tooltip property.

Additional methods are available using inheritance: IWDViewElement.