Pentangle

Pentangle shape class using SVG tag 'polygon'. It's usually treated as a transient shape.

See SVG specification 1.1 for the 'polygon' element for detail information of the html tag.

Following SVG image shows how the properties are designed:

Constructor Summary

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

Method Summary

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

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

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

getRadius(oData, oRowInfo)Gets the value of property radius.

getRadius2(oData, oRowInfo)Gets the value of property radius2.

setRadius(sRadius)Sets a new value for property radius.

setRadius2(sRadius2)Sets a new value for property radius2.

Constructor Detail

new sap.gantt.shape.ext.Pentangle(sId?, mSettings?)

Creates and initializes a new Pentangle 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
- radius : number (default: 10)
- radius2 : number (default: undefined)

Parameters:

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

Method Detail

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

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

Returns a metadata object for class sap.gantt.shape.ext.Pentangle.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getPoints(oData, oRowInfo): string

Gets the value of property d.

points attribute of the polygon element. See SVG 1.1 specification for 'points' attribute of 'polygon'.

Your application should not configure this value. Instead, the getter calculates the value of d by using properties radius and radus2. The value of these properties can be retrieved using the corresponding getters (getRadius and getRadius2). If your application overwrites the value of d by configuration or code, accurate results cannot be guaranteed.

Parameters:

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

Returns:

{string} Value of property points.

getRadius(oData, oRowInfo): number

Gets the value of property radius.

Radius of a pentangle shape.

This property influences property points.

Parameters:

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

Returns:

{number} Value of property radius.

getRadius2(oData, oRowInfo): number

Gets the value of property radius2.

The second radius of a pentangle shape. If this property is not provided, radius2 is set to a value making radius and radius2 fit the golden ratio.

This property influences property points.

Parameters:

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

Returns:

{number} Value of property radius2.

setRadius(sRadius): sap.gantt.shape.ext.Pentangle

Sets a new value for property radius.

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

Default value is 10.

Parameters:

{number} sRadius New value for property radius

Returns:

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

setRadius2(sRadius2): sap.gantt.shape.ext.Pentangle

Sets a new value for property radius2.

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

Default value is undefined.

Parameters:

{number} sRadius2 New value for property radius2

Returns:

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