Class sap.gantt.shape.GroupModule: sap/gantt/shape/Group
Group shape class using SVG tag 'group'. It is a container shape. Any other shapes can be aggregated under a group.
See SVG specification 1.1 for 'group' element for more information about the HTML tag.
Constructor Summary
Method Summary
sap.gantt.shape.Group.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.shape.Group with name
sClassName and enriches it with the information contained in oClassInfo.getRLSAnchors(oData, oRowObjectInfo)To enable connections between in-row shapes, a custom Group class has to be implemented that extends
sap.gantt.shape.Group. Constructor Detail
new sap.gantt.shape.Group(sId?, mSettings?)
Creates and initializes a new Group class.
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
- tag : string (default: g)
- RLSAnchors : array
- Aggregations
- shapes : sap.gantt.shape.Shape[]
Parameters:
| {string} | sId? | ID of the new control, generated automatically if no ID is given |
| {object} | mSettings? | Initial settings for the new control |
Method Detail
sap.gantt.shape.Group.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.shape.Group with name
sClassName and enriches it with the information contained in oClassInfo. oClassInfo might contain the same kind of information as described in Object.extend.
Parameters:
| {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 |
Returns:
| {function} | Created class / constructor function |
sap.gantt.shape.Group.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.shape.Group.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
addShape(oShape): sap.gantt.shape.Group
Adds some shape to the aggregation
shapes. Parameters:
| {sap.gantt.shape.Shape} | oShape | the shape to add; if empty, nothing is inserted |
Returns:
| {sap.gantt.shape.Group} | Reference to this in order to allow method chaining |
destroyShapes(): sap.gantt.shape.Group
Destroys all the shapes in the aggregation
shapes. Returns:
| {sap.gantt.shape.Group} | Reference to this in order to allow method chaining |
getRLSAnchors(oData, oRowObjectInfo): object
To enable connections between in-row shapes, a custom Group class has to be implemented that extends
sap.gantt.shape.Group. Additionally, the getRLSAnchors method has to be implemented for the Relationship class to know the coordinates of the connection points. Parameters:
| {object} | oData | Shape data. |
| {object} | oRowObjectInfo | Information about the row and the row data. |
Returns:
| {object} | Coordinates of the "from" shape (start) and "to" shape (end) |
getShapes(): sap.gantt.shape.Shape[]
Gets content of aggregation
shapes. Returns:
| {sap.gantt.shape.Shape[]} |
getTag(oData, oRowInfo): string
Gets the value of property
tag. SVG tag name of the shape. See SVG 1.1 specification for shapes.
Note: We do not recommend that you change this value using a configuration or coding.
Parameters:
| {object} | oData | Shape data. |
| {object} | oRowInfo | Information about the row and the row data. |
Returns:
| {string} | Value of property tag. |
indexOfShape(oShape): int
Checks for the provided
sap.gantt.shape.Shape in the aggregation shapes. and returns its index if found or -1 otherwise. Parameters:
| {sap.gantt.shape.Shape} | oShape | The shape whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
insertShape(oShape, iIndex): sap.gantt.shape.Group
Inserts a shape into the aggregation
shapes. Parameters:
| {sap.gantt.shape.Shape} | oShape | the shape to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the shape should be inserted at; for a negative value of iIndex, the shape is inserted at position 0; for a value greater than the current size of the aggregation, the shape is inserted at the last position |
Returns:
| {sap.gantt.shape.Group} | Reference to this in order to allow method chaining |
removeAllShapes(): sap.gantt.shape.Shape[]
Removes all the controls from the aggregation
shapes. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.gantt.shape.Shape[]} | An array of the removed elements (might be empty) |
removeShape(vShape): sap.gantt.shape.Shape
Removes a shape from the aggregation
shapes. Parameters:
| {int|string|sap.gantt.shape.Shape} | vShape | The shapeto remove or its index or id |
Returns:
| {sap.gantt.shape.Shape} | The removed shape or null |
setRLSAnchors(sRLSAnchors): sap.gantt.shape.Group
Sets a new value for property
RLSAnchors. When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {array} | sRLSAnchors | New value for property RLSAnchors |
Returns:
| {sap.gantt.shape.Group} | Reference to this in order to allow method chaining |
setTag(sTag): sap.gantt.shape.Group
Sets a new value for property
tag. When called with a value of null or undefined, the default value of the property will be restored.
Default value is g.
Parameters:
| {string} | sTag | New value for property tag |
Returns:
| {sap.gantt.shape.Group} | Reference to this in order to allow method chaining |