Polygon

known direct subclasses: UbcPolygon

Polygon shape class using SVG tag 'polygon'.

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

Sample of 'polygon' in SVG specification 1.1:

Constructor Summary

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

Method Summary

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

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

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

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

setPoints(sPoints)Sets a new value for property points.

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

Constructor Detail

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

Creates and initializes a new Polygon 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: polygon)
- points : string

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getPoints(oData, oRowInfo): string

Gets the value of property points.

Points attribute of the polygon element. See SVG 1.1 specification for 'points' attribute of 'polygon'. Rich extension of paths is provided in namespace sap.gantt.shape.ext.
This shape provides a default implementation of points:

Parameters:

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

Returns:

{string} Value of property points.

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.

setPoints(sPoints): sap.gantt.shape.Polygon

Sets a new value for property points.

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

Parameters:

{string} sPoints New value for property points

Returns:

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

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

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

Parameters:

{string} sTag New value for property tag

Returns:

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