Web Dynpro Series API - IWDSeries (SAP Library

Web Dynpro Series API - IWDSeries

Overview

The Series object is used to specify a more complex data series. You can use this object for displaying data series if you do not want to display a category-based chart or if the number of data series is not definite at design time.

A data series represented by the Series object can contain exactly one Point object.

Property Descriptions

· customizingID
An ID is assigned to this property, and the ID stores information about the representation of the data series under the Customizing XML file of the BusinessGraphics UI element.

· dataBeginIndex
This property can be used to display a selection of node elements of the bound context node. The dataLength property is used to define the number of node elements to be selected.

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

· pointSource
This property is used to specify the data source. You can use it to specify the path to the context node that provides the data for this object.

· dataLength
You can use this property to specify the number of node elements if you have specified a selection using the dataBeginIndex property.

· label
This property is used to specify an optional text to be displayed for a point in a business graphic.

· leadSelectionCustomizingID
This property can be used to select an alternative Customizing. The data series must be selected.

· showSelectedOnly
A Boolean value that describes the selection of a data series. If the value is set to true, only the selected data series are displayed.

· tooltip
Describes a note that is displayed when the user places the cursor on the area of the data series.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
customizingID	IWDSeries	String	No	bindable	No
dataBeginIndex	IWDSeries	int	0	bindable	No
dataLength	IWDSeries	int	0	bindable	No
eventID	IWDSeries	String		bindable	No
label	IWDSeries	String (TranslatableText)	No	bindable	No
leadSelectionCustomizingID	IWDSeries	String	No	bindable	No
pointSource	IWDSeries	Object	No	bindable_mandatory	No
showSelectedOnly	IWDSeries	boolean	false	not_bindable	No
tooltip	IWDSeries	String (TranslatableText)	No	bindable	No

Methods in the Web Dynpro IWDSeries API

Method Name	Parameter	Return Value	Short Description
bindCustomizingID	(String path)		Binds the customizingID property to the context node specified by a path.
bindDataBeginIndex	(String path)		Binds the dataBeginIndex property to the context node specified by a path.
bindDataLength	(String path)		Binds the dataLength property to the context node specified by a path.
bindEventID	(String path)		Binds the eventID property to the context node specified by a path.
bindingOfCustomizingID		String	Returns the path of the context element to which the customizingID property is bound. Returns NULL if no binding exists.
bindingOfDataBeginIndex		String	Returns the path of the context element to which the dataBeginIndex property is bound. Returns NULL if no binding exists.
bindingOfDataLength		String	Returns the path of the context element to which the dataLength 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.
bindingOfLabel		String	Returns the path of the context element to which the label property is bound. Returns NULL if no binding exists.
bindingOfLeadSelectionCustomizingID		String	Returns the path of the context element to which the leadSelectionCustomizingID property is bound. Returns NULL if no binding exists.
bindingOfPointSource		String	Returns the path of the context element to which the pointSource property is bound. Returns NULL if no binding exists.
bindingOfTooltip		String	Returns the path of the content element to which the tooltip property is bound. Returns NULL if no binding exists.
bindLabel	(String path)		Binds the label property to the context node specified by a path.
bindLeadSelectionCustomizingID	(String path)		Binds the leadSelectionCustomizingID property to the context node specified by a path.
bindPointSource	(String path)		Binds the pointSource property to the context node specified by a path.
bindTooltip	(String path)		Binds the value of the tooltip property to the context element specified by the path.
destroyPoint			Removes and deletes the point element for this Series element.
getCustomizingID		String	Returns the value of the customizingID property.
getDataBeginIndex		int	Returns the value of the dataBeginIndex property.
getDataLength		int	Returns the value of the dataLength property.
getEventID		String	Returns the value of the eventID property.
getLabel		String	Returns the value of the label property.
getLeadSelectionCustomizingID		String	Returns the value of the leadSelectionCustomizingID property.
getPoint		IWDPoint	Returns the point element for this Series element.
getShowSelectedOnly		boolean	Returns the value of the showSelectedOnly property.
getTooltip		String	Returns the value of the tooltip property.
setCustomizingID	(String value)		Sets the value of the customizingID property.
setDataBeginIndex	(int value)		Sets the value of the dataBeginIndex property.
setDataLength	(int value)		Sets the value of the dataLength property.
setEventID	(String eventID)		Sets the value of the eventID property.
setLabel	(String value)		Sets the value of the label property.
setLeadSelectionCustomizingID	(String value)		Sets the value of the leadSelectionCustomizingID property.
setPoint	(IWDPoint point)		Sets the point element for this Series element.
setShowSelectedOnly	(Boolean showSelectedOnly)		Sets the value of the showSelectedOnly property.
setTooltip	(String value)		Sets the value of the tooltip property.

Additional methods are available using inheritance: IWDAbstractSeries, IWDViewElement.