Class sap.ui.vbm.RouteModule: sap/ui/vbm/Route
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.
sClassName and enriches it with the information contained in oClassInfo.sap.ui.vbm.DragSource in the aggregation dragSource.sap.ui.vbm.DropTarget in the aggregation dropTarget. Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- position : string
- color : string (default: RGB(0;0;0))
- start : string (default: 0)
- end : string (default: 0)
- linewidth : string (default: 3)
- dotcolor : string (default: RGB(0;0;0))
- dotbordercolor : string (default: RGB(0;0;0))
- colorBorder : string
- lineDash : string
- dotwidth : string (default: 0)
- routetype : sap.ui.vbm.RouteType (default: Straight)
- directionIndicator : boolean (default: false)
- Aggregations
- dragSource : sap.ui.vbm.DragSource[]
- dropTarget : sap.ui.vbm.DropTarget[]
In addition, all settings applicable to the base type sap.ui.vbm.VoBase can be used as well.
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
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.
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
| {function} | Created class / constructor function |
| {sap.ui.base.Metadata} | Metadata object describing this class |
dragSource. | {sap.ui.vbm.DragSource} | oDragSource | the dragSource to add; if empty, nothing is inserted |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
dropTarget. | {sap.ui.vbm.DropTarget} | oDropTarget | the dropTarget to add; if empty, nothing is inserted |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
dragSource. | {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
dropTarget. | {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
color. The color of the route.
Default value is RGB(0;0;0).
| {string} | Value of property color |
colorBorder. The border color of the route.
| {string} | Value of property colorBorder |
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.
| {boolean} | Value of property directionIndicator |
dotbordercolor. The border color of the line dots of a route.
Default value is RGB(0;0;0).
| {string} | Value of property dotbordercolor |
dotcolor. The color for the line dots of a route.
Default value is RGB(0;0;0).
| {string} | Value of property dotcolor |
dotwidth. The diameter of a dot in a route.
Default value is 0.
| {string} | Value of property dotwidth |
dragSource. DragSource aggregation
| {sap.ui.vbm.DragSource[]} |
dropTarget. DropTarget aggregation
| {sap.ui.vbm.DropTarget[]} |
end. The end point type of the route.
- 0: no endpoint
- 1: arrow as endpoint
Default value is 0.
| {string} | Value of property end |
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.
| {string} | Value of property lineDash |
linewidth. The width of the route line. With width 0 no line is drawn.
Default value is 3.
| {string} | Value of property linewidth |
position. The position array of the route. The format is "lon0;lat0;0;...lonN;latN;0".
| {string} | Value of property position |
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.
Experimental API:Since 1.32.0 this method is experimental and might be modified or removed in future versions.
- Experimental:
- Since 1.32.0 this method is experimental and might be modified or removed in future versions.
| {sap.ui.vbm.RouteType} | Value of property routetype |
start. The start point type of the route.
- 0: no startpoint
- 1: arrow head as startpoint
Default value is 0.
| {string} | Value of property start |
sap.ui.vbm.DragSource in the aggregation dragSource. and returns its index if found or -1 otherwise. | {sap.ui.vbm.DragSource} | oDragSource | The dragSource whose index is looked for |
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
sap.ui.vbm.DropTarget in the aggregation dropTarget. and returns its index if found or -1 otherwise. | {sap.ui.vbm.DropTarget} | oDropTarget | The dropTarget whose index is looked for |
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
dragSource. | {sap.ui.vbm.DragSource} | oDragSource | the dragSource to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the dragSource should be inserted at; for a negative value of iIndex, the dragSource is inserted at position 0; for a value greater than the current size of the aggregation, the dragSource is inserted at the last position |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
dropTarget. | {sap.ui.vbm.DropTarget} | oDropTarget | the dropTarget to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the dropTarget should be inserted at; for a negative value of iIndex, the dropTarget is inserted at position 0; for a value greater than the current size of the aggregation, the dropTarget is inserted at the last position |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
dragSource. Additionally, it unregisters them from the hosting UIArea.
| {sap.ui.vbm.DragSource[]} | An array of the removed elements (might be empty) |
dropTarget. Additionally, it unregisters them from the hosting UIArea.
| {sap.ui.vbm.DropTarget[]} | An array of the removed elements (might be empty) |
dragSource. | {int|string|sap.ui.vbm.DragSource} | vDragSource | The dragSourceto remove or its index or id |
| {sap.ui.vbm.DragSource} | The removed dragSource or null |
dropTarget. | {int|string|sap.ui.vbm.DropTarget} | vDropTarget | The dropTargetto remove or its index or id |
| {sap.ui.vbm.DropTarget} | The removed dropTarget or null |
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).
| {string} | sColor | New value for property color |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {string} | sColorBorder | New value for property colorBorder |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {boolean} | bDirectionIndicator | New value for property directionIndicator |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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).
| {string} | sDotbordercolor | New value for property dotbordercolor |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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).
| {string} | sDotcolor | New value for property dotcolor |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {string} | sDotwidth | New value for property dotwidth |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
end. The end point type of the route.
- 0: no endpoint
- 1: arrow as endpoint
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 0.
| {string} | sEnd | New value for property end |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {string} | sLineDash | New value for property lineDash |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {string} | sLinewidth | New value for property linewidth |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
| {string} | sPosition | New value for property position |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
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.
Experimental API:Since 1.32.0 this method is experimental and might be modified or removed in future versions.
| {sap.ui.vbm.RouteType} | sRoutetype | New value for property routetype |
- Experimental:
- Since 1.32.0 this method is experimental and might be modified or removed in future versions.
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |
start. The start point type of the route.
- 0: no startpoint
- 1: arrow head as startpoint
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 0.
| {string} | sStart | New value for property start |
| {sap.ui.vbm.Route} | Reference to this in order to allow method chaining |