ClipPath

known direct subclasses: UlcClipPath

Clippath shape class using SVG container tag 'clippath'. It is usually used together with sap.gantt.shape.Path as aggregations, and referenced by other shapes by URL.

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

Circle samples in SVG specification 1.1:

Constructor Summary

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

Method Summary

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

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

addPath(oPath)Adds some path to the aggregation paths.

destroyPaths()Destroys all the paths in the aggregation paths.

getPaths()Gets content of aggregation paths.

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

indexOfPath(oPath)Checks for the provided sap.gantt.shape.Path in the aggregation paths.

insertPath(oPath, iIndex)Inserts a path into the aggregation paths.

removeAllPaths()Removes all the controls from the aggregation paths.

removePath(vPath)Removes a path from the aggregation paths.

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

Constructor Detail

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

Creates and initializes a new Clippath 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: clippath)
Aggregations
- paths : sap.gantt.shape.Path[]

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addPath(oPath): sap.gantt.shape.ClipPath

Adds some path to the aggregation paths.

Parameters:

{sap.gantt.shape.Path}

oPath

the path to add; if empty, nothing is inserted

Returns:

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

destroyPaths(): sap.gantt.shape.ClipPath

Destroys all the paths in the aggregation paths.

Returns:

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

getPaths(): sap.gantt.shape.Path[]

Gets content of aggregation paths.

Paths defining the clipPath.

Returns:

{sap.gantt.shape.Path[]}

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.

indexOfPath(oPath): int

Checks for the provided sap.gantt.shape.Path in the aggregation paths. and returns its index if found or -1 otherwise.

Parameters:

{sap.gantt.shape.Path}

oPath

The path whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertPath(oPath, iIndex): sap.gantt.shape.ClipPath

Inserts a path into the aggregation paths.

Parameters:

{sap.gantt.shape.Path}	oPath	the path to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the path should be inserted at; for a negative value of `iIndex`, the path is inserted at position 0; for a value greater than the current size of the aggregation, the path is inserted at the last position

Returns:

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

removeAllPaths(): sap.gantt.shape.Path[]

Removes all the controls from the aggregation paths.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.gantt.shape.Path[]}

An array of the removed elements (might be empty)

removePath(vPath): sap.gantt.shape.Path

Removes a path from the aggregation paths.

Parameters:

{int|string|sap.gantt.shape.Path}