Class sap.gantt.def.gradient.StopModule: sap/gantt/def/gradient/Stop

extends DefBase

Gradient stop defined by SVG tag 'stop'.

See 'stop' element in SVG 1.1 specification for detail.

Constructor Summary
new sap.gantt.def.gradient.Stop(sId?, mSettings?)Creates and initializes a gradient stop defined for later reuse.
Method Summary
sap.gantt.def.gradient.Stop.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.def.gradient.Stop with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.def.gradient.Stop.getMetadata()Returns a metadata object for class sap.gantt.def.gradient.Stop.
getOffSet()Gets current value of property offSet.
getStopColor()Gets current value of property stopColor.
setOffSet(sOffSet)Sets a new value for property offSet.
setStopColor(sStopColor)Sets a new value for property stopColor.
Constructor Detail
new sap.gantt.def.gradient.Stop(sId?, mSettings?)
Creates and initializes a gradient stop defined for later reuse.

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
    • offSet : string (default: 5%)
    • stopColor : sap.gantt.ValueSVGPaintServer (default: #FFFFFF)

In addition, all settings applicable to the base type sap.gantt.def.DefBase can be used as well.

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.def.gradient.Stop.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.def.gradient.Stop with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.gantt.def.DefBase.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.def.gradient.Stop.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.def.gradient.Stop.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getOffSet(): string
Gets current value of property offSet.

Attribute 'offset' of SVG tag 'stop'. See 'offset' attribute of 'stop' element in SVG 1.1 specification for detail.

Default value is 5%.

Returns:
{string} Value of property offSet
Gets current value of property stopColor.

Property 'stop-color' of SVG tag 'stop'. See 'stop-color' property of 'stop' element in SVG 1.1 specification for detail.

Default value is #FFFFFF.

Returns:
{sap.gantt.ValueSVGPaintServer} Value of property stopColor
setOffSet(sOffSet): sap.gantt.def.gradient.Stop
Sets a new value for property offSet.

Attribute 'offset' of SVG tag 'stop'. See 'offset' attribute of 'stop' element in SVG 1.1 specification for detail.

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

Default value is 5%.

Parameters:
{string}sOffSet New value for property offSet
Returns:
{sap.gantt.def.gradient.Stop} Reference to this in order to allow method chaining
setStopColor(sStopColor): sap.gantt.def.gradient.Stop
Sets a new value for property stopColor.

Property 'stop-color' of SVG tag 'stop'. See 'stop-color' property of 'stop' element in SVG 1.1 specification for detail.

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

Default value is #FFFFFF.

Parameters:
{sap.gantt.ValueSVGPaintServer}sStopColor New value for property stopColor
Returns:
{sap.gantt.def.gradient.Stop} Reference to this in order to allow method chaining