Shape

known direct subclasses: UtilizationLineChart

Base class for all shape classes.

Shape class is designed to describe how data should be visualized by an SVG tag. Most shape classes contain only properties and only one aggregation:

Some properties come from standard SVG attribute. Examples are fill, stroke etc.
Some properties designed to put Shape class into Gantt chart's coordinate system, especially the X axis called sap.gantt.misc.AxisTime. Examples are time, endTime etc.
Some properties are designed to provide some geometry attributes. Examples are side, center in some extend shapes.
Every shape has aggregation called selectedShape to provide a way to specify how selection of the shape should be designed.
Some container shapes like g and clippath has aggregation to aggregate other shapes in.

Because d3 is used underneath and d3 use array to do batch data-binding, therefore Shape classes are not designed in the way of SAPUI5 standard data-binding (one shape instance per data). Instead, each Shape instance stands for a particular way of visualize one data structure. And one Shape instance is used to draw a list of data by Drawers in Gantt chart.

Because of this specialty, application cannot instantiate a shape class directly. Instead they can use configuration sap.gantt.config.Shape to describe which Shape class is used to draw which data in what way. And pass this configuration to Gantt chart control by property shapes. Gantt chart control use these configurations to instatiate Shape instances and Drawers. Drawers consumes Shape instances to draw real SVG shapes.

Each shape classes are designed to support 'configuration-first' principle. So called configure is the shapeProperties property of sap.gantt.config.Shape. In this object property, application can provide following things:

A value. Example: {tooltip: 'svg rocks'}.
An attribute from data. Example: {time: {startTime}}
Formatted attribute from data. {tooltip: "{time:Timestamp} the stock price falls to {price:Number}."} The typed values are formatted by global legacy number, date and time configurations by sap.gantt.misc.Format.

In many applications, simple configuration or even binding cannot meet business requriement. Therefore applications are allowed to extend shapes and provide their own getter methods to effect all properties by data. For in row shapes, two parameters are injected to help application to do coding. All the shapes provided by Gantt chart follows 'configuration first' principle by invoking method _configFirst(). Meaning if application provide value by sap.gantt.config.Shape, the configuration over-write code logic in getters.

Note: Setter methods are only used for set default values. Because a Shape instance stands for a way of drawing. The instance self does not hold any status (property values). Meanwhile, all getter are injected with actual data and related informations to adapt to d3 paradigm.

Constructor Summary

new sap.gantt.shape.Shape(sId?, mSettings?)Creates and initializes a new Shape class.

Method Summary

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

sap.gantt.shape.Shape.getMetadata()Returns a metadata object for class sap.gantt.shape.Shape.

_configFirst(sAttrName, oData, bScaleBySapUiSizeMode)This method must be used to ensure 'configuration-first' principle for extended shapes.

_rotate(oData, oRowInfo, aRetVal)Rotate Shape

_rtlRotation(nAngle)Provide logic for rotation considering RTL.

_translate(oData, oRowInfo, aRetVal)Translate Shape

destroySelectedShape()Destroys the selectedShape in the aggregation selectedShape.

getAriaLabel(oData, oRowInfo)Gets current value of property ariaLabel.

getArrayAttribute(oData, oRowInfo)Gets current value of property arrayAttribute.

getAxisTime()Get the AxisTime of gantt chart instance

getCategory(oData, oRowInfo)Gets current value of property category.

getClipPath(oData, oRowInfo)Gets current value of property clipPath.

getEnableDnD(oData, oRowInfo)Gets current value of property enableDnD.

getEnableSelection(oData, oRowInfo)Gets current value of property enableSelection.

getEndTime(oData, oRowInfo)Gets current value of property endTime.

getEndTimeFilterAttribute(oData, oRowInfo)Gets current value of property endTimeFilterAttribute.

getFill(oData, oRowInfo)Gets current value of property fill.

getFillOpacity(oData, oRowInfo)Gets current value of property fillOpacity.

getFilter(oData, oRowInfo)Gets current value of property filter.

getHtmlClass(oData, oRowInfo)Gets current value of property htmlClass.

getIsBulk(oData, oRowInfo)Gets current value of property isBulk.

getIsDuration(oData, oRowInfo)Gets current value of property isDuration.

getLegend(oData)Gets legend value of property legend.

getRotationAngle(oData, oRowInfo)Gets current value of property rotationAngle.

getRotationCenter(oData, oRowInfo)Gets current value of property rotationCenter.

getRowYCenter(oData, oRowInfo)Gets current value of property rowYCenter.

getSelectedShape()Gets content of aggregation selectedShape.

getShapeViewBoundary()This method is used to get view boundary for visible area in Gantt Chart.

getStroke(oData, oRowInfo)Gets current value of property stroke.

getStrokeDasharray(oData, oRowInfo)Gets current value of property strokeDasharray.

getStrokeOpacity(oData)Gets current value of property strokeOpacity.

getStrokeWidth(oData, oRowInfo)Gets current value of property strokeWidth.

getTag(oData, oRowInfo)Gets current value of property tag.

getTime(oData, oRowInfo)Gets current value of property time.

getTimeFilterAttribute(oData, oRowInfo)Gets current value of property timeFilterAttribute.

getTitle(oData, oRowInfo)Gets current value of property title.

getTransform(oData, oRowInfo)Gets current value of property transform.

getXBias(oData, oRowInfo)Gets current value of property xBias.

getYBias(oData, oRowInfo)Gets current value of property yBias.

setAriaLabel(sAriaLabel)Sets a new value for property ariaLabel.

setArrayAttribute(sArrayAttribute)Sets a new value for property arrayAttribute.

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

setClipPath(sClipPath)Sets a new value for property clipPath.

setEnableDnD(bEnableDnD)Sets a new value for property enableDnD.

setEnableSelection(bEnableSelection)Sets a new value for property enableSelection.

setEndTime(sEndTime)Sets a new value for property endTime.

setEndTimeFilterAttribute(sEndTimeFilterAttribute)Sets a new value for property endTimeFilterAttribute.

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

setFillOpacity(sFillOpacity)Sets a new value for property fillOpacity.

setFilter(sFilter)Sets a new value for property filter.

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

setIsBulk(bIsBulk)Sets a new value for property isBulk.

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

setLegend(sLegend)Sets a new value for property legend.

setRotationAngle(sRotationAngle)Sets a new value for property rotationAngle.

setRotationCenter(sRotationCenter)Sets a new value for property rotationCenter.

setRowYCenter(sRowYCenter)Sets a new value for property rowYCenter.

setSelectedShape(oSelectedShape)Sets the aggregated selectedShape.

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

setStrokeDasharray(sStrokeDasharray)Sets a new value for property strokeDasharray.

setStrokeOpacity(sStrokeOpacity)Sets a new value for property strokeOpacity.

setStrokeWidth(sStrokeWidth)Sets a new value for property strokeWidth.

setTag(sTag)Sets a new value for property tag.

setTime(sTime)Sets a new value for property time.

setTimeFilterAttribute(sTimeFilterAttribute)Sets a new value for property timeFilterAttribute.

setTitle(sTitle)Sets a new value for property title.

setTransform(sTransform)Sets a new value for property transform.

setXBias(sXBias)Sets a new value for property xBias.

setYBias(sYBias)Sets a new value for property yBias.

Constructor Detail

new sap.gantt.shape.Shape(sId?, mSettings?)

Creates and initializes a new Shape 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
- category : string (default: sap.gantt.shape.ShapeCategory.InRowShape)
- htmlClass : string
- isDuration : boolean (default: false)
- time : string
- endTime : string
- title : string
- ariaLabel : string
- xBias : number (default: 0)
- yBias : number (default: 0)
- fill : sap.gantt.ValueSVGPaintServer
- strokeOpacity : number (default: 1)
- fillOpacity : number (default: 1)
- stroke : sap.gantt.ValueSVGPaintServer
- strokeWidth : number (default: 0)
- strokeDasharray : string
- clipPath : string
- transform : string
- filter : string
- enableDnD : boolean (default: false)
- enableSelection : boolean (default: true)
- rowYCenter : number (default: 7.5)
- rotationCenter : array
- rotationAngle : number
- isBulk : boolean (default: false)
- arrayAttribute : string
- timeFilterAttribute : string
- endTimeFilterAttribute : string
- legend : string
Aggregations
- selectedShape : sap.gantt.shape.SelectedShape

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

Method Detail

sap.gantt.shape.Shape.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

Returns a metadata object for class sap.gantt.shape.Shape.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

_configFirst(sAttrName, oData, bScaleBySapUiSizeMode): string

This method must be used to ensure 'configuration-first' principle for extended shapes.

Parameters:

{string}	sAttrName	Attribute name.
{object}	oData	Shape data.
{boolean}	bScaleBySapUiSizeMode	whether scale by size mode or not

Returns:

{string}

Resolved attribute.

_rotate(oData, oRowInfo, aRetVal)

Rotate Shape

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Shape Row Info.
{object}	aRetVal	Return Value.

_rtlRotation(nAngle): number

Provide logic for rotation considering RTL.

Parameters:

{number}

nAngle

Rotation angle.

Returns:

{number}

Actual rotation angle.

_translate(oData, oRowInfo, aRetVal)

Translate Shape

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Shape Row Info.
{object}	aRetVal	Return Value.

destroySelectedShape(): sap.gantt.shape.Shape

Destroys the selectedShape in the aggregation selectedShape.

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

getAriaLabel(oData, oRowInfo): string

Gets current value of property ariaLabel.

Arial Label enables screen readers.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property ariaLabel.

getArrayAttribute(oData, oRowInfo): string

Gets current value of property arrayAttribute.

Specify which attribute is child array.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property arrayAttribute.

getAxisTime(): object

Get the AxisTime of gantt chart instance

Returns:

{object}

the AxisTime instance

getCategory(oData, oRowInfo): string

Gets current value of property category.

Values are in enum sap.gantt.shape.ShapeCategory.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property category.

getClipPath(oData, oRowInfo): string

Gets current value of property clipPath.

Standard SVG 'clippath' attribute. See SVG 1.1 specification for 'clippath'.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property clipPath.

getEnableDnD(oData, oRowInfo): boolean

Gets current value of property enableDnD.

This value controls whether a shape is enabled for drag-and-drop behavior.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{boolean} Value of property enableDnD.

getEnableSelection(oData, oRowInfo): boolean

Gets current value of property enableSelection.

This value controls whether a shape is enabled for selection behavior.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{boolean} Value of property enableSelection.

getEndTime(oData, oRowInfo): string

Gets current value of property endTime.

End timestamp for duration shape.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property endTime.

getEndTimeFilterAttribute(oData, oRowInfo): string

Gets current value of property endTimeFilterAttribute.

Specify which is end time attribute of items in child array.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property endTimeFilterAttribute.

getFill(oData, oRowInfo): string

Gets current value of property fill.

Standard SVG 'fill' attribute. See SVG 1.1 specification for 'fill'. Note: HTML color and url reference to paint server can be provided to fill. Paint server definitions usually comes from paint servers rendered by sap.gantt.GanttChartContainer, sap.gantt.GanttChartWithTable or sap.gantt.GanttChart.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property fill.

getFillOpacity(oData, oRowInfo): number

Gets current value of property fillOpacity.

Standard SVG 'fill-Opacity' attribute. See SVG 1.1 specification for 'fill-opacity'.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{number} Value of property fillOpacity.

getFilter(oData, oRowInfo): string

Gets current value of property filter.

Standard SVG 'filter' attribute. See SVG 1.1 specifica6tion for 'filter'. Usually value of filter is an url referenced from paint server definition rendered by sap.gantt.GanttChartContainer, sap.gantt.GanttChartWithTable or sap.gantt.GanttChart.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property filter.

getHtmlClass(oData, oRowInfo): string

Gets current value of property htmlClass.

Customized html classes. Multiple classes can be provided and seperated by space.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property htmlClass.

getIsBulk(oData, oRowInfo): boolean

Gets current value of property isBulk.

Gantt chart do filtering of data by timestamp for performance sake. For simple shapes which has time or endTime provided, set this flag to false. For shapes (path or polygon) which connect a list of data, set this value to false. And if filtering is required to next level data, provide arrayAttribute, timeFilterAttribute and endTimeFilterAttribute in combination.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{boolean} Value of property isBulk.

getIsDuration(oData, oRowInfo): boolean

Gets current value of property isDuration.

When this flag is set to true, the shape is called 'duration shape'. And time stands for startTime, endTime stands for end time. When this flag is set to be false, the shape is called 'transient shape'. And only time is used. Usually these 3 properties are used to determine x position of one shape.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{boolean} Value of property isDuration.

getLegend(oData): string

Gets legend value of property legend.

Specifies the legend text of the shape.

Parameters:

{object}

oData

Shape data.

Returns:

{string} Value of property legend.

getRotationAngle(oData, oRowInfo): number

Gets current value of property rotationAngle.

This value is used in combination of property rotationCenter. By providing both shape can be rotated with any angle around rotation center.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{number} Value of property rotationAngle.

getRotationCenter(oData, oRowInfo): array

Gets current value of property rotationCenter.

This value is used in combination of property rotationAngle. By providing both shape can be rotated with any angle around rotation center. Default implementation is the coordinate at time in x coordinate, and rowYCenter in y coordinate. If application over-write this property by configuration or code, the logic cannot be guaranteed.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{array} Value of property rotationCenter.

getRowYCenter(oData, oRowInfo): array

Gets current value of property rowYCenter.

Default implementation is return the middle position of the row in y direction. If application over-write this property by configuration or code, the logic cannot be guaranteed.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{array} Value of property rowYCenter.

getSelectedShape(): sap.gantt.shape.SelectedShape

Gets content of aggregation selectedShape.

Selected Shape.

Selected shape specifies how to draw the selection high-light. Application can implement it by extending sap.gantt.shape.SelectedShape and configure it in sap.gantt.config.Shape.

Returns:

{sap.gantt.shape.SelectedShape}

getShapeViewBoundary(): array

This method is used to get view boundary for visible area in Gantt Chart. The view boundary is a range of x-coordinate for visible area.

Returns:

{array}

View boundary for visible area in Gantt Chart.

getStroke(oData, oRowInfo): string

Gets current value of property stroke.

Standard SVG 'stroke' attribute. See SVG 1.1 specification for 'stroke'. Note: HTML color and url reference to paint server can be provided to stroke. Paint server definitions usually comes from paint servers rendered by sap.gantt.GanttChartContainer, sap.gantt.GanttChartWithTable or sap.gantt.GanttChart.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property stroke.

getStrokeDasharray(oData, oRowInfo): string

Gets current value of property strokeDasharray.

Standard SVG 'stroke-dasharray' attribute. See SVG 1.1 specification for 'stroke-dasharray'.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property strokeDasharray.

getStrokeOpacity(oData): number

Gets current value of property strokeOpacity.

Standard SVG 'stroke-Opacity' attribute. See SVG 1.1 specification for 'stroke-opacity'.

Parameters:

{object}

oData

Shape data.

Returns:

{number} Value of property strokeOpacity.

getStrokeWidth(oData, oRowInfo): number

Gets current value of property strokeWidth.

Standard SVG 'stroke-width' attribute. See SVG 1.1 specification for 'stroke-width'.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{number} Value of property strokeWidth.

getTag(oData, oRowInfo): string

Gets current value of property tag.

SVG tag name of the shape. See SVG 1.1 specification for shapes.
Note: This value is not recommended to be over-written by configuration or coding.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property tag.

getTime(oData, oRowInfo): string

Gets current value of property time.

Timestamp for transient shape or start timestamp for duration shape.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property time.

getTimeFilterAttribute(oData, oRowInfo): string

Gets current value of property timeFilterAttribute.

Specify which is time attribute of items in child array.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property timeFilterAttribute.

getTitle(oData, oRowInfo): string

Gets current value of property title.

Title is visualized as tooltip by browser. Notes: Use character entity to do simple text tabbing and breaking. (Use " " for tab and " " for break.) See SVG 1.1 specification for 'title'.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property title.

getTransform(oData, oRowInfo): string

Gets current value of property transform.

Standard SVG 'transform' attribute. See SVG 1.1 specifica6tion for 'transform'. Some logic in getTransform() is provided to enable property rotationCenter and rotationAngle. If application over-write this property by configuration or coding, rotation behavior cannot be guaranteed.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{string} Value of property transform.

getXBias(oData, oRowInfo): number

Gets current value of property xBias.

Fine-tune x coordinate. This value only works for category inRowShape. Shape usually determines position in x coordinate by property isDuration, time and endTime. Application can use this property to do some x coordinate adjustment in pixel. The xBias will be automatically mirrored for RTL mode. It means if you set 10 to property xBias, in RTL mode, the value of the xBias will be -10.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{number} Value of property xBias.

getYBias(oData, oRowInfo): number

Gets current value of property yBias.

Fine-tune y coordinate. This value only works for category inRowShape. Y coordinate is automatically determined by row. Application can use this property to do some y coordinate adjustment in pixel.

Parameters:

{object}	oData	Shape data.
{object}	oRowInfo	Information of the row and row data.

Returns:

{number} Value of property yBias.

setAriaLabel(sAriaLabel): sap.gantt.shape.Shape

Sets a new value for property ariaLabel.

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

Parameters:

{string} sAriaLabel New value for property ariaLabel

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setArrayAttribute(sArrayAttribute): sap.gantt.shape.Shape

Sets a new value for property arrayAttribute.

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

Parameters:

{string} sArrayAttribute New value for property arrayAttribute

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setCategory(sCategory): sap.gantt.shape.Shape

Sets a new value for property category.

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.InRowShape.

Parameters:

{string} sCategory New value for property category

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setClipPath(sClipPath): sap.gantt.shape.Shape

Sets a new value for property clipPath.

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

Parameters:

{string} sClipPath New value for property clipPath

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setEnableDnD(bEnableDnD): sap.gantt.shape.Shape

Sets a new value for property enableDnD.

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

Default value is false.

Parameters:

{boolean} bEnableDnD New value for property enableDnD

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setEnableSelection(bEnableSelection): sap.gantt.shape.Shape

Sets a new value for property enableSelection.

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

Default value is true.

Parameters:

{boolean} bEnableSelection New value for property enableSelection

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setEndTime(sEndTime): sap.gantt.shape.Shape

Sets a new value for property endTime.

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

Parameters:

{string} sEndTime New value for property endTime

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setEndTimeFilterAttribute(sEndTimeFilterAttribute): sap.gantt.shape.Shape

Sets a new value for property endTimeFilterAttribute.

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

Parameters:

{string} sEndTimeFilterAttribute New value for property endTimeFilterAttribute

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setFill(sFill): sap.gantt.shape.Shape

Sets a new value for property fill.

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

Parameters:

{sap.gantt.ValueSVGPaintServer} sFill New value for property fill

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setFillOpacity(sFillOpacity): sap.gantt.shape.Shape

Sets a new value for property fillOpacity.

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

Default value is 1.

Parameters:

{number} sFillOpacity New value for property fillOpacity

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setFilter(sFilter): sap.gantt.shape.Shape

Sets a new value for property filter.

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

Parameters:

{string} sFilter New value for property filter

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setHtmlClass(sHtmlClass): sap.gantt.shape.Shape

Sets a new value for property htmlClass.

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

Parameters:

{string} sHtmlClass New value for property htmlClass

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setIsBulk(bIsBulk): sap.gantt.shape.Shape

Sets a new value for property isBulk.

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

Default value is false.

Parameters:

{boolean} bIsBulk New value for property isBulk

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setIsDuration(bIsDuration): sap.gantt.shape.Shape

Sets a new value for property isDuration.

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.Shape} Reference to this in order to allow method chaining

setLegend(sLegend): sap.gantt.shape.Shape

Sets a new value for property legend.

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

Parameters:

{string} sLegend New value for property legend

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setRotationAngle(sRotationAngle): sap.gantt.shape.Shape

Sets a new value for property rotationAngle.

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

Parameters:

{number} sRotationAngle New value for property rotationAngle

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setRotationCenter(sRotationCenter): sap.gantt.shape.Shape

Sets a new value for property rotationCenter.

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

Parameters:

{array} sRotationCenter New value for property rotationCenter

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setRowYCenter(sRowYCenter): sap.gantt.shape.Shape

Sets a new value for property rowYCenter.

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

Default value is 7.5.

Parameters:

{number} sRowYCenter New value for property rowYCenter

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setSelectedShape(oSelectedShape): sap.gantt.shape.Shape

Sets the aggregated selectedShape.

Parameters:

{sap.gantt.shape.SelectedShape}

oSelectedShape

The selectedShape to set

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setStroke(sStroke): sap.gantt.shape.Shape

Sets a new value for property stroke.

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

Parameters:

{sap.gantt.ValueSVGPaintServer} sStroke New value for property stroke

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setStrokeDasharray(sStrokeDasharray): sap.gantt.shape.Shape

Sets a new value for property strokeDasharray.

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

Parameters:

{string} sStrokeDasharray New value for property strokeDasharray

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setStrokeOpacity(sStrokeOpacity): sap.gantt.shape.Shape

Sets a new value for property strokeOpacity.

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

Default value is 1.

Parameters:

{number} sStrokeOpacity New value for property strokeOpacity

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setStrokeWidth(sStrokeWidth): sap.gantt.shape.Shape

Sets a new value for property strokeWidth.

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

Default value is 0.

Parameters:

{number} sStrokeWidth New value for property strokeWidth

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setTag(sTag): sap.gantt.shape.Shape

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.

Parameters:

{string} sTag New value for property tag

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setTime(sTime): sap.gantt.shape.Shape

Sets a new value for property time.

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

Parameters:

{string} sTime New value for property time

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setTimeFilterAttribute(sTimeFilterAttribute): sap.gantt.shape.Shape

Sets a new value for property timeFilterAttribute.

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

Parameters:

{string} sTimeFilterAttribute New value for property timeFilterAttribute

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setTitle(sTitle): sap.gantt.shape.Shape

Sets a new value for property title.

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

Parameters:

{string} sTitle New value for property title

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setTransform(sTransform): sap.gantt.shape.Shape

Sets a new value for property transform.

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

Parameters:

{string} sTransform New value for property transform

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setXBias(sXBias): sap.gantt.shape.Shape

Sets a new value for property xBias.

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

Default value is 0.

Parameters:

{number} sXBias New value for property xBias

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining

setYBias(sYBias): sap.gantt.shape.Shape

Sets a new value for property yBias.

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

Default value is 0.

Parameters:

{number} sYBias New value for property yBias

Returns:

{sap.gantt.shape.Shape} Reference to this in order to allow method chaining