Specific Visual Object element for a Route. A Route is a polyline, which is given as a list of geo-coordinates. In order to indicate direction an arrow head can be added at start and end. Further it is possible to have a dot at each point of the coordinate list.
Since the actual length of a route depends on the zoom level it might be only partly visible. Thus detail windows will be dynamically positioned in the middle of the visible route part.
A Route supports GeoMap internal drag'n drop with fine grained control on matching drag sources and drop targets. A drag'n drop operation is possible if any type in the drag source aggregation of the dragged visual object matches a type in the drop target aggregation of the target vo. Drag source and drop target types defined on element level apply only for a single element instance, except the element is used as template.
Constructor for a new Route.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vbm.Route(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
color | string | RGB(0;0;0) | The color of the route. Visibility: public |
colorBorder | string | The border color of the route. Visibility: public |
|
directionIndicator | boolean | false | Set to true if intermediate triangles along the route should show the direction only applicable if arrow head is defined ( start and/or end ) it is not recommended to use line dots in addition because the direction indicators generate additional line points at their head and base positions Visibility: public |
dotbordercolor | string | RGB(0;0;0) | The border color of the line dots of a route. Visibility: public |
dotcolor | string | RGB(0;0;0) | The color for the line dots of a route. Visibility: public |
dotwidth | string | 0 | The diameter of a dot in a route. Visibility: public |
end | string | 0 | The end point type of the route.
|
lineDash | string | Defines the dashing style of the route using an array. The first value gives the length of the stroke and the second the length of the gap. Thus "1;1", would result in a doted line. However, strokes are painted with rounded endings. Thus the actual stroke length depends also on the line width. As a sample a stroke of 1 pixel length and a line width of 6 will result in at least 6 pixels total length. In that case the line dashing should be set to "1;6" for an equal length of stroke and gap! |
|
linewidth | string | 3 | The width of the route line. With width 0 no line is drawn. Visibility: public |
position | string | The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0". Visibility: public |
|
routetype | sap.ui.vbm.RouteType | Straight | Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest path between two points, e.g. flightroutes Visibility: public |
start | string | 0 | The start point type of the route.
|
Name | Type | Default Value | Description |
---|---|---|---|
changeable | boolean | false | Set to true if VO is changeable. Which properties are actually changeable can be controlled on the related VO aggregation. Visibility: public |
dragData | string | Data to be dragged. This property allows you to provide an arbitrary data string, which is transfered to the target in a drag'n drop operation Visibility: public |
|
entity | string | The visual object builds an entity/group with other VO elements when it is hovered. The property is not supported when the PlugIn is used. Visibility: public |
|
fxdir | string | true | The visual object is not rotated when the map is rotated. The property is only required when the PlugIn is used and only meaningful for some VOs. Visibility: public |
fxsize | string | true | The visual object should keep its size when the map is zoomed. Default value is 'true'. Only meaningful for some VOs. Visibility: public |
hotDeltaColor | string | RHLSA(0;1.3;1.0;1.0) | Color change applied when visual object is hovered. The format is RHLSA(<hue>;<lightness>;<saturation>;<opacity>). The hue shift is given in degree (0 to 360). The other parameters are given as multipliers, where 1 means the component remains unchanged. |
hotScale | string | 1.0;1.0;1.0 | Scaling factor applied when visual object is hovered. This is only supported on selected VOs, which do not present a defined geo area. Visibility: public |
key | string | Unique identifier for the object. This is optional. If not provided the default identifier sId is used. However, sId is generated if template binding is used and thus it is not stable. Provide the key if the object really needs to have a unique and stable identifier. Visibility: public |
|
labelArrow | boolean | false | The visual objects label arrow. For left/right/top/bottom aligned labels an additional arrow points to the label's object. Visibility: public |
labelBgColor | string | RGB(255;255;255) | The visual objects label background color. The default value is white. Visibility: public |
labelBorderColor | string | The visual objects label border color. The default is no border. Visibility: public |
|
labelPos | string | The visual objects label position. This property determines the positioning of the label relative to the VO it belongs to. Possible values are:
For multiple position based VOs, like Route, or Area the label is dynamically positioned. If the current display of a VO consists of multiple disconnected parts, each part gets an own label.Visibility: public |
|
labelText | string | The visual objects label text. Providing a label text required, but also sufficient the get a label displayed. Visibility: public |
|
labelType | sap.ui.vbm.SemanticType | None | Type for semantic labels. A given semantic type will overrule color settings and add an icon. Visibility: public |
select | boolean | false | Set to true if the element is selected Visibility: public |
selectColor | string | RHLSA(0.0;1.0;1.0;1.0) | Color change applied when visual object is selected. This can be explicit or a relative one. See above. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
dragSource | 0..n | sap.ui.vbm.DragSource |
DragSource aggregation |
dropTarget | 0..n | sap.ui.vbm.DropTarget |
DropTarget aggregation |
Method | Description |
---|---|
addDragSource |
Adds some dragSource to the aggregation dragSource. |
addDropTarget |
Adds some dropTarget to the aggregation dropTarget. |
destroyDragSource |
Destroys all the dragSource in the aggregation dragSource. |
destroyDropTarget |
Destroys all the dropTarget in the aggregation dropTarget. |
sap.ui.vbm.Route.extend |
Creates a new subclass of class sap.ui.vbm.Route with name
|
getColor |
Gets current value of property color. The color of the route. Default value is |
getColorBorder |
Gets current value of property colorBorder. The border color of the route. |
getDirectionIndicator |
Gets current value of property directionIndicator. Set to true if intermediate triangles along the route should show the direction only applicable if arrow head is defined ( start and/or end ) it is not recommended to use line dots in addition because the direction indicators generate additional line points at their head and base positions Default value is |
getDotbordercolor |
Gets current value of property dotbordercolor. The border color of the line dots of a route. Default value is |
getDotcolor |
Gets current value of property dotcolor. The color for the line dots of a route. Default value is |
getDotwidth |
Gets current value of property dotwidth. The diameter of a dot in a route. Default value is |
getDragSource |
Gets content of aggregation dragSource. DragSource aggregation |
getDropTarget |
Gets content of aggregation dropTarget. DropTarget aggregation |
getEnd |
Gets current value of property end. The end point type of the route.
Default value is |
getLineDash |
Gets current value of property lineDash. Defines the dashing style of the route using an array. The first value gives the length of the stroke and the second the length of the gap. Thus "1;1", would result in a doted line. However, strokes are painted with rounded endings. Thus the actual stroke length depends also on the line width. As a sample a stroke of 1 pixel length and a line width of 6 will result in at least 6 pixels total length. In that case the line dashing should be set to "1;6" for an equal length of stroke and gap! |
getLinewidth |
Gets current value of property linewidth. The width of the route line. With width 0 no line is drawn. Default value is |
sap.ui.vbm.Route.getMetadata |
Returns a metadata object for class sap.ui.vbm.Route. |
getPosition |
Gets current value of property position. The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0". |
getRoutetype |
Gets current value of property routetype. Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest path between two points, e.g. flightroutes Default value is |
getStart |
Gets current value of property start. The start point type of the route.
Default value is |
indexOfDragSource |
Checks for the provided |
indexOfDropTarget |
Checks for the provided |
insertDragSource |
Inserts a dragSource into the aggregation dragSource. |
insertDropTarget |
Inserts a dropTarget into the aggregation dropTarget. |
removeAllDragSource |
Removes all the controls from the aggregation dragSource. Additionally, it unregisters them from the hosting UIArea. |
removeAllDropTarget |
Removes all the controls from the aggregation dropTarget. Additionally, it unregisters them from the hosting UIArea. |
removeDragSource |
Removes a dragSource from the aggregation dragSource. |
removeDropTarget |
Removes a dropTarget from the aggregation dropTarget. |
setColor |
Sets a new value for property color. The color of the route. When called with a value of Default value is |
setColorBorder |
Sets a new value for property colorBorder. The border color of the route. When called with a value of |
setDirectionIndicator |
Sets a new value for property directionIndicator. Set to true if intermediate triangles along the route should show the direction only applicable if arrow head is defined ( start and/or end ) it is not recommended to use line dots in addition because the direction indicators generate additional line points at their head and base positions When called with a value of Default value is |
setDotbordercolor |
Sets a new value for property dotbordercolor. The border color of the line dots of a route. When called with a value of Default value is |
setDotcolor |
Sets a new value for property dotcolor. The color for the line dots of a route. When called with a value of Default value is |
setDotwidth |
Sets a new value for property dotwidth. The diameter of a dot in a route. When called with a value of Default value is |
setEnd |
Sets a new value for property end. The end point type of the route.
When called with a value of Default value is |
setLineDash |
Sets a new value for property lineDash. Defines the dashing style of the route using an array. The first value gives the length of the stroke and the second the length of the gap. Thus "1;1", would result in a doted line. However, strokes are painted with rounded endings. Thus the actual stroke length depends also on the line width. As a sample a stroke of 1 pixel length and a line width of 6 will result in at least 6 pixels total length. In that case the line dashing should be set to "1;6" for an equal length of stroke and gap! When called with a value of |
setLinewidth |
Sets a new value for property linewidth. The width of the route line. With width 0 no line is drawn. When called with a value of Default value is |
setPosition |
Sets a new value for property position. The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0". When called with a value of |
setRoutetype |
Sets a new value for property routetype. Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest path between two points, e.g. flightroutes When called with a value of Default value is |
setStart |
Sets a new value for property start. The start point type of the route.
When called with a value of Default value is |
Adds some dragSource to the aggregation dragSource.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDragSource | sap.ui.vbm.DragSource |
The dragSource to add; if empty, nothing is inserted |
Adds some dropTarget to the aggregation dropTarget.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDropTarget | sap.ui.vbm.DropTarget |
The dropTarget to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.vbm.Route with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.vbm.VoBase.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property directionIndicator.
Set to true if intermediate triangles along the route should show the direction only applicable if arrow head is defined ( start and/or end ) it is not recommended to use line dots in addition because the direction indicators generate additional line points at their head and base positions
Default value is false
.
Gets current value of property dotbordercolor.
The border color of the line dots of a route.
Default value is 'RGB(0;0;0)'
.
Gets current value of property dotcolor.
The color for the line dots of a route.
Default value is 'RGB(0;0;0)'
.
Gets current value of property dotwidth.
The diameter of a dot in a route.
Default value is '0'
.
Gets current value of property end.
The end point type of the route.
Default value is '0'
.
Gets current value of property lineDash.
Defines the dashing style of the route using an array. The first value gives the length of the stroke and the second the length of the gap. Thus "1;1", would result in a doted line. However, strokes are painted with rounded endings. Thus the actual stroke length depends also on the line width. As a sample a stroke of 1 pixel length and a line width of 6 will result in at least 6 pixels total length. In that case the line dashing should be set to "1;6" for an equal length of stroke and gap!
The line dashing array can be extended to achive more complex pattern, e.g. "1;1;5;2" and so on.
Gets current value of property linewidth.
The width of the route line. With width 0 no line is drawn.
Default value is '3'
.
Gets current value of property position.
The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0".
Gets current value of property routetype.
Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest path between two points, e.g. flightroutes
Default value is 'Straight'
.
Gets current value of property start.
The start point type of the route.
Default value is '0'
.
Checks for the provided sap.ui.vbm.DragSource
in the aggregation dragSource. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDragSource | sap.ui.vbm.DragSource |
The dragSource whose index is looked for |
Checks for the provided sap.ui.vbm.DropTarget
in the aggregation dropTarget. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDropTarget | sap.ui.vbm.DropTarget |
The dropTarget whose index is looked for |
Inserts a dragSource into the aggregation dragSource.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDragSource | sap.ui.vbm.DragSource |
The dragSource to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Inserts a dropTarget into the aggregation dropTarget.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDropTarget | sap.ui.vbm.DropTarget |
The dropTarget to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation dragSource.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation dropTarget.
Additionally, it unregisters them from the hosting UIArea.
Removes a dragSource from the aggregation dragSource.
Param | Type | DefaultValue | Description |
---|---|---|---|
vDragSource | int string sap.ui.vbm.DragSource |
The dragSource to remove or its index or id |
Removes a dropTarget from the aggregation dropTarget.
Param | Type | DefaultValue | Description |
---|---|---|---|
vDropTarget | int string sap.ui.vbm.DropTarget |
The dropTarget to remove or its index or id |
Sets a new value for property color.
The color of the route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 'RGB(0;0;0)'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColor | string | 'RGB(0;0;0)' |
New value for property |
Sets a new value for property colorBorder.
The border color of the route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColorBorder | string |
New value for property |
Sets a new value for property directionIndicator.
Set to true if intermediate triangles along the route should show the direction only applicable if arrow head is defined ( start and/or end ) it is not recommended to use line dots in addition because the direction indicators generate additional line points at their head and base positions
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bDirectionIndicator | boolean | false |
New value for property |
Sets a new value for property dotbordercolor.
The border color of the line dots of a route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 'RGB(0;0;0)'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDotbordercolor | string | 'RGB(0;0;0)' |
New value for property |
Sets a new value for property dotcolor.
The color for the line dots of a route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 'RGB(0;0;0)'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDotcolor | string | 'RGB(0;0;0)' |
New value for property |
Sets a new value for property dotwidth.
The diameter of a dot in a route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '0'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDotwidth | string | '0' |
New value for property |
Sets a new value for property end.
The end point type of the route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '0'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sEnd | string | '0' |
New value for property |
Sets a new value for property lineDash.
Defines the dashing style of the route using an array. The first value gives the length of the stroke and the second the length of the gap. Thus "1;1", would result in a doted line. However, strokes are painted with rounded endings. Thus the actual stroke length depends also on the line width. As a sample a stroke of 1 pixel length and a line width of 6 will result in at least 6 pixels total length. In that case the line dashing should be set to "1;6" for an equal length of stroke and gap!
The line dashing array can be extended to achive more complex pattern, e.g. "1;1;5;2" and so on.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLineDash | string |
New value for property |
Sets a new value for property linewidth.
The width of the route line. With width 0 no line is drawn.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '3'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLinewidth | string | '3' |
New value for property |
Sets a new value for property position.
The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0".
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPosition | string |
New value for property |
Sets a new value for property routetype.
Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest path between two points, e.g. flightroutes
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 'Straight'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sRoutetype | sap.ui.vbm.RouteType | 'Straight' |
New value for property |
Sets a new value for property start.
The start point type of the route.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '0'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sStart | string | '0' |
New value for property |