Entering content frame

Object documentation Web Dynpro Point API - IWDPoint Locate the document in its SAP Library structure

Overview

The Point object defines the structure of the points of a more complex data series. The data binding and the subobject structure of a Point object indicates the number of values and their value types of a data point in a data series. A data series represented by the Series object can contain exactly one Point object. A Point object can be filled with one or more value objects, either the NumericValue class or the TimeValue class.

Property Descriptions

·        customizingID
Describes how the chart is displayed on the screen. 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.

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

·        valueSource
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.

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

·        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

IWDPoint

String

 

bindable

No

eventID

IWDPoint

String

 

bindable

No

valueSource

IWDPoint

Object

 

bindable_mandatory

No

label

IWDPoint

String (TranslatableText)

 

bindable

No

tooltip

IWDPoint

String (TranslatableText)

 

bindable

No

Methods in the Web Dynpro IWDPoint API

Method Name

Parameter

Return Value

Short Description

addValue

(IWDAbstractValue value)

 

Adds a value element at the end of the value elements list.

addValue

(IWDAbstractValue value, int index)

 

Adds a value element at the specified index position of the value elements list.

bindEventID

(String path)

 

Binds the eventID property to the context node specified by a path.

bindCustomizingID

(String path)

 

Binds the customizingID 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.

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.

bindingOfTooltip

 

String

Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists.

bindingOfValueSource

 

String

Returns the path of the context element to which the valueSource property is bound. Returns NULL if no binding exists.

bindLabel

(String path)

 

Binds the label 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.

bindValueSource

(String path)

 

Binds the valueSource property to the context node specified by a path.

destroyAllValues

 

 

Removes all value elements. These are destroyed and no longer exist, so that the associated IDs can be used for new elements.

getCustomizingID

 

String

Returns the value of the customizingID property.

getEventID

 

String

Returns the value of the eventID property.

getLabel

 

String

Returns the value of the label property.

getSeries

 

IWDSeries

Returns the Series element in which this Point element is contained.

getTooltip

 

String

Returns the value of the tooltip property.

getValues

 

IWDAbstractValue[]

Returns an array of the value elements.

hasValues

 

boolean

Checks whether or not value elements exist in this point element.

iterateValues

 

Iterator

Returns an iterator about all value elements in this point element.

numberOfValues

 

int

Returns the number of the value elements.

removeAllValues

 

 

Removes all value elements. They remain and can be added to this point element.

removeValue

int index

IWDAbstractValue

Removes the value element at the specified index position.

removeValue

String id

IWDAbstractValue

Removes the value element with the specified ID.

setCustomizingID

(String customizingID)

 

Sets the value of the customizingID property.

setEventID

(String eventID)

 

Sets the value of the eventID property.

setLabel

(String label)

 

Sets the value of the label property.

setTooltip

(String tooltip)

 

Sets the value of the tooltip property.

Additional methods are available using inheritance: IWDViewElement.

  

  

 

Leaving content frame