Path

known direct subclasses: SelectedShape, UbcBorderPath, UlcBorderPath, UlcClipingPath

Path shape class using SVG tag 'path'.

See SVG specification 1.1 for 'path' element for more information about the HTML tag.

Sample of closed path in SVG specification 1.1:

Sample of open curve path in SVG specification 1.1:

Constructor Summary

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

Method Summary

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

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

getD(oData, oRowInfo)Gets the value of property d.

getFill()Gets current value of property fill.

getIsClosed(oData, oRowInfo)Gets the value of property isClosed.

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

setD(sD)Sets a new value for property d.

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

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

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

Constructor Detail

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

Creates and initializes a new Path 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: path)
- isClosed : boolean (default: false)
- fill : string (default: none)
- d : string

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.Path.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getD(oData, oRowInfo): string

Gets the value of property d.

d attribute of path element. See SVG 1.1 specification for 'd' attribute of 'path'. The 'd' attribute has very powerful grammar. See BNF grammar for more information. Rich extension of paths is provided in namespace sap.gantt.shape.ext.
This shape provides a default implementation of the d attribute:

Parameters:

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

Returns:

{string} Value of property d.

getFill(): string

Gets current value of property fill.

Default value is none.

Returns:

{string} Value of property fill

getIsClosed(oData, oRowInfo): boolean

Gets the value of property isClosed.

When this value is true, the 'fill' attribute is applied. Otherwise, the 'fill' attribute is none.

Parameters:

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

Returns:

{boolean} Value of property isClosed.

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.

setD(sD): sap.gantt.shape.Path

Sets a new value for property d.

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

Parameters:

{string} sD New value for property d

Returns:

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

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

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.

Default value is none.

Parameters:

{string} sFill New value for property fill

Returns:

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

setIsClosed(bIsClosed): sap.gantt.shape.Path

Sets a new value for property isClosed.

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

Default value is false.

Parameters:

{boolean} bIsClosed New value for property isClosed

Returns:

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

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

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

Parameters:

{string} sTag New value for property tag

Returns:

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