Web
Dynpro GeoMap API - IWDGeoMap 
Definition
You can use the GeoMap UI element to display a section of a map.
You use the values of the properties top, left, bottom, and right to specify the geographical coordinates and define the map section to be displayed. The geographical coordinates are derived from the longitude and latitude values of a geographical location and must be entered in WGS84 format based on the reference system World Geodetic System –1984 (WGS84).
The following values show a geographical section of Walldorf/Heidelberg:
|
top: 49.4304 left: 8.5082 bottom: 49.2000 right: 8.7922
|
|
The GeoMap UI element can only be used with a special software component that is provided by the geographical maps.
This software component which you can use to expand the Internet Graphics Service (IGS) is not included in the delivered SAP Web Application Server package. It must be purchased from a third-party provider. The GeoMap UI element cannot be displayed without this complementary software component.
Property Descriptions
·
accessibilityDescription
When accessibility is activated, the assigned text is added to the tooltip.
This description provides semantic details of the UI element and is only read
by the screen reader if the user focuses the complete Ul element.
·
bottom
You can use this property to specify the value of a geographical coordinate in
decimal numbers according to the standard World Geodetic System – 1984
(WGS84). Together with the value of the right
property, the lower right
position of the section is specified.
·
geoObjectSource
You can position so-called geo objects in the map and use them to highlight a
specific position. These geo objects are used to provide specific information
to the user. For example, you can mark the starting point or finishing point
of a route on the map. This property must be bound to a
context attribute.
·
height
Specifies the height of the
UI element in pixels.
·
igsURL
You can use this property to
specify the Web address (URL) of the server on which the Internet Graphics
Service is to 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.
·
left
You can use this property to specify the value of a geographical coordinate in
decimal numbers according to the standard World Geodetic System – 1984
(WGS84). Together with the value of the top property, the upper left position of the
section is specified.
·
moveType
This property specifies
whether the geographical border of a map can be interactively changed by the
user. The moveType
property can be filled
with the following values and is represented by the enumeration type WDMoveType:
none |
You cannot change the geographical border. |
panel |
Control elements allow you to change the geographical border. |
·
right
You can use this property to specify the value of a geographical coordinate in
decimal numbers according to the standard World Geodetic System – 1984
(WGS84). Together with the value of the bottom
property, the lower right
position of the section is specified.
·
top
You can use this property to specify the value of a geographical coordinate in
decimal numbers according to the standard World Geodetic System – 1984
(WGS84). Together with the value of the left
property, the upper left
position of the section is specified.
·
width
Specifies the width of the UI
element in pixels.
·
zoomType
Specifies the zoom behavior
of the map. The zoomType
property can be filled
with the following values and is represented by the enumeration type
WDZoomType:
none |
Zooming within the map is not possible, and no control elements for zooming are available. |
panel |
Zooming within the map is possible. |
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
accessibilityDescription |
IWDGeoMap |
String (TranslatableText) |
|
bindable |
No |
bottom |
IWDGeoMap |
double |
0.0 |
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
geoObjectSource |
IWDGeoMap |
IWDGeoObject |
|
bindable_mandatory |
No |
height |
IWDGeoMap |
int |
300 |
not_bindable |
No |
igsURL |
IWDGeoMap |
String |
|
not_bindable |
No |
IWDAbstractIgsElement |
String |
|
not_bindable |
No |
|
left |
IWDGeoMap |
double |
0.0 |
bindable |
No |
IWDAbstractIgsElement |
String |
|
not_bindable |
No |
|
moveType |
IWDGeoMap |
WDMoveType |
none |
not_bindable |
No |
right |
IWDGeoMap |
double |
0.0 |
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
top |
IWDGeoMap |
double |
0.0 |
not_bindable |
No |
IWDUIElement |
visibility |
visible |
bindable |
No |
|
width |
IWDGeoMap |
int |
300 |
not_bindable |
No |
zoomType |
IWDGeoMap |
WDZoomType |
none |
not_bindable |
No |
Events
·
onObjectAction
This property contains the
action that is executed when the user activates a geo object.
Event Parameter |
Type |
ID |
String |
For further
information, refer to Parameter
Mapping.
Data Binding
For an example of
data binding of the UI element properties, refer to Code Example of the Use of a
Geographical Map.
Methods in the Web Dynpro IWDGeoMap API
Method Name |
Parameter |
Return Value |
Description |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindBottom |
(String path) |
|
Binds the bottom property to the context node specified by a path. |
bindGeoObjectSource |
(String path) |
|
Binds the value of the geoObjectSource property to the context element specified by the path. |
bindingOfAccessibilityDescription |
|
String |
Returns the path of the context element to which the accessibilityDescription property is bound. Returns NULL if no binding exists. |
bindingOfBottom |
|
String |
Returns the path of the content element to which the bottom property is bound. Returns NULL if no binding exists. |
bindingOfGeoObjectSource |
|
String |
Returns the path of the context element to which the geoObjectSource property is bound. Returns NULL if no binding exists. |
bindingOfLeft |
|
String |
Returns the path of the content element to which the left property is bound. Returns NULL if no binding exists. |
bindingOfRight |
|
String |
Returns the path of the content element to which the right property is bound. Returns NULL if no binding exists. |
bindingOfTop |
|
String |
Returns the path of the content element to which the top property is bound. Returns NULL if no binding exists. |
bindLeft |
(String path) |
|
Binds the value of the left property to the context element specified by the path. |
bindRight |
(String path) |
|
Binds the right property to the context node specified by a path. |
bindTop |
(String path) |
|
Binds the top property to the context node specified by a path. |
getAccessibilityDescription |
|
String |
Returns the value of the accessibilityDescription property. |
getBottom |
|
double |
Returns the value of the bottom property. |
getGeoObjectSource |
|
IWDGeoObject |
Returns the value of the geoObjectSource property. |
getHeight |
|
int |
Returns the value of the height property. |
getIgsUrl |
|
String |
Returns the value of the igsUrl property. |
getLeft |
|
double |
Returns the value of the left property. |
getMoveType |
|
WDMoveType |
Returns the value of the moveType property. |
getOnObjectAction |
|
IWDAction |
Returns the action that is executed if the onObjectAction event is raised. |
getRight |
|
double |
Returns the value of the right property. |
getTop |
|
double |
Returns the value of the top property. |
getWidth |
|
int |
Returns the value of the width property. |
getZoomType |
|
WDZoomType |
Returns the value of the zoomType property. |
mappingOfOnObjectAction |
|
IWDParameterMapping |
Returns the parameter mapping for the onObjectAction action. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setBottom |
(double bottom) |
|
Sets the value of the bottom property. |
setGeoObjectSource |
(IWDGeoObject geoObjectSource) |
|
Sets the value of the geoObjectSource property. |
setHeight |
(int height) |
|
Sets the value of the height property. |
setIgsUrl |
(String igsUrl) |
|
Sets the value of the igsUrl property. |
setLeft |
(double left) |
|
Sets the value of the left property. |
setMoveType |
(WDMoveType moveType) |
|
Sets the value of the moveType property. |
setOnObjectAction |
(IWDAction action) |
|
Sets the action that is executed if the onObjectAction event is raised. |
setRight |
(double right) |
|
Sets the value of the right property. |
setTop |
(double top) |
|
Sets the value of the top property. |
setWidth |
(int width) |
|
Sets the value of the width property. |
setZoomType |
(WDZoomType zoomType) |
|
Sets the value of the zoomType property. |
Additional methods described in the following APIs are available using inheritance: IWDAbstractIgsElement, IWDUIElement, IWDViewElement.