Relationship

known direct subclasses: SelectedRelationship

Enables users to visualize the relationship between elements.

Four types of relationships are supported and L-shaped lines are supported for the finish-to-start type.

Constructor Summary

new sap.gantt.shape.ext.rls.Relationship(sId?, mSetting?)Creates and initializes a Relationship object

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Method Summary

sap.gantt.shape.ext.rls.Relationship.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.shape.ext.rls.Relationship with name sClassName and enriches it with the information contained in oClassInfo.

sap.gantt.shape.ext.rls.Relationship.getMetadata()Returns a metadata object for class sap.gantt.shape.ext.rls.Relationship.

destroySelectedShape()Destroys the selectedShape in the aggregation selectedShape.

getArrowSideLength()Gets current value of property arrowSideLength.

getCategory()Gets current value of property category.

getFill()Gets current value of property fill.

getFromDataId(oData)Gets the data of the predecessor element

getFromObjectPath(oData)Gets the path of predecessor object

getFromShapeId(oData)Gets the shape ID of the predecessor element

getHtmlClass(oData)Gets the CSS class of the relationship shape

getIsClosed()Gets current value of property isClosed.

getIsDuration()Gets current value of property isDuration.

getLShapeforTypeFS(oData)Gets the'L' shape switch

getMinXLen()Gets current value of property minXLen.

getSelectedShape()Gets content of aggregation selectedShape.

getShowEnd(oData)Gets whether the end shape is visible

getShowStart(oData)Gets whether the start shape is visible

getStroke()Gets current value of property stroke.

getToDataId(oData)Gets the data of the successor element

getToObjectPath(oData)Gets the path of the successor element

getToShapeId(oData)Gets the shape ID of the successor element

getType(oData)Gets the relationship type

setArrowSideLength(sArrowSideLength)Sets a new value for property arrowSideLength.

setCategory(sCategory)Sets a new value for property category.

setFill(sFill)Sets a new value for property fill.

setFromDataId(sFromDataId)Sets a new value for property fromDataId.

setFromObjectPath(sFromObjectPath)Sets a new value for property fromObjectPath.

setFromShapeId(sFromShapeId)Sets a new value for property fromShapeId.

setHtmlClass(sHtmlClass)Sets a new value for property htmlClass.

setIsClosed(bIsClosed)Sets a new value for property isClosed.

setIsDuration(bIsDuration)Sets a new value for property isDuration.

setLShapeforTypeFS(bLShapeforTypeFS)Sets a new value for property lShapeforTypeFS.

setMinXLen(sMinXLen)Sets a new value for property minXLen.

setSelectedShape(oSelectedShape)Sets the aggregated selectedShape.

setShowEnd(bShowEnd)Sets a new value for property showEnd.

setShowStart(bShowStart)Sets a new value for property showStart.

setStroke(sStroke)Sets a new value for property stroke.

setToDataId(sToDataId)Sets a new value for property toDataId.

setToObjectPath(sToObjectPath)Sets a new value for property toObjectPath.

setToShapeId(sToShapeId)Sets a new value for property toShapeId.

setType(sType)Sets a new value for property type.

Constructor Detail

new sap.gantt.shape.ext.rls.Relationship(sId?, mSetting?)

Creates and initializes a Relationship object

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
- htmlClass : string (default: relationshipLine)
- category : string (default: sap.gantt.shape.ShapeCategory.Relationship)
- isClosed : boolean (default: true)
- isDuration : boolean (default: false)
- stroke : string (default: #000000)
- fill : string (default: #000000)
- type : sap.gantt.shape.ext.rls.RelationshipType (default: FinishToFinish)
- fromObjectPath : string
- fromShapeId : string
- fromDataId : string
- toObjectPath : string
- toShapeId : string
- toDataId : string
- showStart : boolean (default: false)
- showEnd : boolean (default: true)
- lShapeforTypeFS : boolean (default: true)
- minXLen : number (default: 10)
- arrowSideLength : number (default: 5)
Aggregations
- selectedShape : sap.gantt.shape.ext.rls.SelectedRelationship

Parameters:

{string}	sId?	ID for the new control, generated automatically if no is given
{object}	mSetting?	Initial settings for the new control

Method Detail

sap.gantt.shape.ext.rls.Relationship.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.gantt.shape.ext.rls.Relationship 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.ext.rls.Relationship.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.gantt.shape.ext.rls.Relationship.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

destroySelectedShape(): sap.gantt.shape.ext.rls.Relationship

Destroys the selectedShape in the aggregation selectedShape.

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

getArrowSideLength(): number

Gets current value of property arrowSideLength.

Size of the arrow

Default value is 5.

Returns:

{number} Value of property arrowSideLength

getCategory(): string

Gets current value of property category.

Category name

Default value is sap.gantt.shape.ShapeCategory.Relationship.

Returns:

{string} Value of property category

getFill(): string

Gets current value of property fill.

Fill color of the relationship shape (the color of the arrow and the square at the ends)

Default value is #000000.

Returns:

{string} Value of property fill

getFromDataId(oData): string

Gets the data of the predecessor element

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Data of predecessor

getFromObjectPath(oData): string

Gets the path of predecessor object

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Path of predecessor element

getFromShapeId(oData): string

Gets the shape ID of the predecessor element

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Shape ID of the predecessor element

getHtmlClass(oData): string

Gets the CSS class of the relationship shape

Parameters:

{object}

oData

Raw data object

Returns:

{string}

CSS class name of the relationship shape

getIsClosed(): boolean

Gets current value of property isClosed.

Indicates whether the shape is a closed path

Default value is true.

Returns:

{boolean} Value of property isClosed

getIsDuration(): boolean

Gets current value of property isDuration.

Indicates whether the width of the polygon represents the duration of time

Default value is false.

Returns:

{boolean} Value of property isDuration

getLShapeforTypeFS(oData): boolean

Gets the'L' shape switch

Parameters:

{object}

oData

Raw data object

Returns:

{boolean}

'L' shape configuration (whether the system uses L-shaped lines to represent finish-start relationships)

getMinXLen(): number

Gets current value of property minXLen.

Minimum length for relationship lines

Default value is 10.

Returns:

{number} Value of property minXLen

getSelectedShape(): sap.gantt.shape.ext.rls.SelectedRelationship

Gets content of aggregation selectedShape.

Returns:

{sap.gantt.shape.ext.rls.SelectedRelationship}

getShowEnd(oData): boolean

Gets whether the end shape is visible

Parameters:

{object}

oData

Raw data object

Returns:

{boolean}

End shape configuration (whether the end shape is visible

getShowStart(oData): boolean

Gets whether the start shape is visible

Parameters:

{object}

oData

Raw data object

Returns:

{boolean}

Start shape configuration (whether the start shape is visible)

getStroke(): string

Gets current value of property stroke.

Line color of the relationship shape

Default value is #000000.

Returns:

{string} Value of property stroke

getToDataId(oData): string

Gets the data of the successor element

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Data of the successor element

getToObjectPath(oData): string

Gets the path of the successor element

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Path of the successor element

getToShapeId(oData): string

Gets the shape ID of the successor element

Parameters:

{object}

oData

Raw data object

Returns:

{string}

Shape ID of the successor element

getType(oData): number

Gets the relationship type

Parameters:

{object}

oData

Raw data object

Returns:

{number}

The type number (from 0 to 3)

setArrowSideLength(sArrowSideLength): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property arrowSideLength.

Size of the arrow

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 5.

Parameters:

{number} sArrowSideLength New value for property arrowSideLength

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setCategory(sCategory): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property category.

Category name

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.gantt.shape.ShapeCategory.Relationship.

Parameters:

{string} sCategory New value for property category

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setFill(sFill): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property fill.

Fill color of the relationship shape (the color of the arrow and the square at the ends)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is #000000.

Parameters:

{string} sFill New value for property fill

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setFromDataId(sFromDataId): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property fromDataId.

Data of predecessor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sFromDataId New value for property fromDataId

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setFromObjectPath(sFromObjectPath): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property fromObjectPath.

Path of predecessor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sFromObjectPath New value for property fromObjectPath

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setFromShapeId(sFromShapeId): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property fromShapeId.

Shape of predecessor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sFromShapeId New value for property fromShapeId

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setHtmlClass(sHtmlClass): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property htmlClass.

CSS class name of the relationship shape

When called with a value of null or undefined, the default value of the property will be restored.

Default value is relationshipLine.

Parameters:

{string} sHtmlClass New value for property htmlClass

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setIsClosed(bIsClosed): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property isClosed.

Indicates whether the shape is a closed path

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bIsClosed New value for property isClosed

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setIsDuration(bIsDuration): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property isDuration.

Indicates whether the width of the polygon represents the duration of time

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:

{boolean} bIsDuration New value for property isDuration

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setLShapeforTypeFS(bLShapeforTypeFS): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property lShapeforTypeFS.

Indicates whether an 'L' shape is used for the finish-to-start type

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bLShapeforTypeFS New value for property lShapeforTypeFS

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setMinXLen(sMinXLen): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property minXLen.

Minimum length for relationship lines

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 10.

Parameters:

{number} sMinXLen New value for property minXLen

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setSelectedShape(oSelectedShape): sap.gantt.shape.ext.rls.Relationship

Sets the aggregated selectedShape.

Parameters:

{sap.gantt.shape.ext.rls.SelectedRelationship}

oSelectedShape

The selectedShape to set

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setShowEnd(bShowEnd): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property showEnd.

Indicates whether the end point (arrow) of the relationship shape is visible

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bShowEnd New value for property showEnd

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setShowStart(bShowStart): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property showStart.

Indicates whether the start point (square) of the relationship shape is visible

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:

{boolean} bShowStart New value for property showStart

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setStroke(sStroke): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property stroke.

Line color of the relationship shape

When called with a value of null or undefined, the default value of the property will be restored.

Default value is #000000.

Parameters:

{string} sStroke New value for property stroke

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setToDataId(sToDataId): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property toDataId.

Data of successor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sToDataId New value for property toDataId

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setToObjectPath(sToObjectPath): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property toObjectPath.

Path of successor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sToObjectPath New value for property toObjectPath

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setToShapeId(sToShapeId): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property toShapeId.

Shape of successor element

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sToShapeId New value for property toShapeId

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining

setType(sType): sap.gantt.shape.ext.rls.Relationship

Sets a new value for property type.

Relationship type

When called with a value of null or undefined, the default value of the property will be restored.

Default value is FinishToFinish.

Parameters:

{sap.gantt.shape.ext.rls.RelationshipType} sType New value for property type

Returns:

{sap.gantt.shape.ext.rls.Relationship} Reference to this in order to allow method chaining