Circle

Circle shape class using SVG tag 'circle'. This shape is usually used to represent points in time.

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

Circle samples in SVG specification 1.1:

Constructor Summary

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

Method Summary

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

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

getCx(oData, oRowInfo)Gets the value of property cx.

getCy(oData, oRowInfo)Gets the current value of property cy.

getR(oData, oRowInfo)Gets the value of property r.

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

setCx(sCx)Sets a new value for property cx.

setCy(sCy)Sets a new value for property cy.

setR(sR)Sets a new value for property r.

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

Constructor Detail

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

Creates and initializes a new Circle 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: circle)
- cx : number
- cy : number
- r : number (default: 5)

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getCx(oData, oRowInfo): number

Gets the value of property cx.

x coordinate of the center of the circle. See SVG 1.1 specification for 'cx' attribute of 'circle'.

Usually applications do not set this value. This getter carries out the calculation using the time property as a base and makes some adjustments.

Parameters:

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

Returns:

{number} Value of property cx.

getCy(oData, oRowInfo): number

Gets the current value of property cy.

y coordinate of the center of the circle. See SVG 1.1 specification for 'cy' attribute of 'circle'.

Usually applications do not set this value. This getter carries out the calculation using parameter oRowInfo as a base and makes some adjustments to align the center of the row rectangle along the y axis. If you override the default value calculated by the getter, the alignment of the center is not guaranteed.

Parameters:

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

Returns:

{number} Value of property cy.

getR(oData, oRowInfo): number

Gets the value of property r.

Radius of the circle. See SVG 1.1 specification for 'r' attribute of 'circle'.

Parameters:

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

Returns:

{number} Value of property r.

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.

setCx(sCx): sap.gantt.shape.Circle

Sets a new value for property cx.

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

Parameters:

{number} sCx New value for property cx

Returns:

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

setCy(sCy): sap.gantt.shape.Circle

Sets a new value for property cy.

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

Parameters:

{number} sCy New value for property cy

Returns:

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

setR(sR): sap.gantt.shape.Circle

Sets a new value for property r.

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

Default value is 5.

Parameters:

{number} sR New value for property r

Returns:

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

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

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

Parameters:

{string} sTag New value for property tag

Returns:

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