class sap.ui.vk.RedlineElementEllipse

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/RedlineElementEllipse
Application Component: CA-UI5-VTK

Provides a control for creating ellipse redline elements.


Constructor

Redline element control for ellipse.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.RedlineElementEllipse()

Properties

Name Type Default Value Description
fillColor sap.ui.core.CSSColor rgba(0, 0, 0, 0) Visibility: public
radiusX float 0.0001 Visibility: public
radiusY float 0.0001 Visibility: public

Borrowed Properties

Name Type Default Value Description
createTimestamp int Visibility: public
createdByUser any empty string Visibility: public
deleteTimestamp int Visibility: public
deletedByUser any empty string Visibility: public
elementId string Visibility: public
halo boolean false Visibility: public
haloColor string rgba(255, 0, 0, 1) Visibility: public
opacity float 1 Visibility: public
originX float 0 Visibility: public
originY float 0 Visibility: public
strokeColor sap.ui.core.CSSColor #e6600d Visibility: public
strokeDashArray float[] Visibility: public
strokeWidth float 2 Visibility: public
suppress boolean false Visibility: public

Methods Overview

Method Description
applyZoom

Changes the current radiusX and radiusY of the ellipse redline element by a factor which gets passed as parameter.

edit

Changes the current radiusX, radiusY, originX and originY of the ellipse redline element with the values passed as parameters.

exportJSON

Exports all the relevant data contained in the ellipse redline element to a JSON object.

exportSVG

Exports all the relevant data contained in the ellipse redline element to an SVG ellipse element.

sap.ui.vk.RedlineElementEllipse.extend

Creates a new subclass of class sap.ui.vk.RedlineElementEllipse with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vk.RedlineElement.extend.

getFillColor

Gets current value of property fillColor.

Default value is "rgba(0, 0, 0, 0)".

sap.ui.vk.RedlineElementEllipse.getMetadata

Returns a metadata object for class sap.ui.vk.RedlineElementEllipse.

getRadiusX

Gets current value of property radiusX.

Default value is 0.0001.

getRadiusY

Gets current value of property radiusY.

Default value is 0.0001.

importJSON

Imports data from a JSON object into the ellipse redline element.

importSVG

Imports data from an SVG ellipse element into the ellipse redline element.

setFillColor

Sets a new value for property fillColor.

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

Default value is "rgba(0, 0, 0, 0)".

setRadiusX

Sets a new value for property radiusX.

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

Default value is 0.0001.

setRadiusY

Sets a new value for property radiusY.

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

Default value is 0.0001.

applyZoom

Changes the current radiusX and radiusY of the ellipse redline element by a factor which gets passed as parameter.

Param Type DefaultValue Description
zoomBy number

The factor to be applied to the current radiusX and radiusY.

edit

Changes the current radiusX, radiusY, originX and originY of the ellipse redline element with the values passed as parameters.

Param Type DefaultValue Description
offsetX number

The value in pixels that radiusX and originX will be calculated from for the ellipse.

offsetY number

The value in pixels that radiusY and originY will be calculated from for the ellipse.

isCircle boolean

True if the element is circle or False/Undefined otherwise.

exportJSON

Exports all the relevant data contained in the ellipse redline element to a JSON object.

exportSVG

Exports all the relevant data contained in the ellipse redline element to an SVG ellipse element.

sap.ui.vk.RedlineElementEllipse.extend

Creates a new subclass of class sap.ui.vk.RedlineElementEllipse with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vk.RedlineElement.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getFillColor

Gets current value of property fillColor.

Default value is "rgba(0, 0, 0, 0)".

sap.ui.vk.RedlineElementEllipse.getMetadata

Returns a metadata object for class sap.ui.vk.RedlineElementEllipse.

getRadiusX

Gets current value of property radiusX.

Default value is 0.0001.

getRadiusY

Gets current value of property radiusY.

Default value is 0.0001.

importJSON

Imports data from a JSON object into the ellipse redline element.

Param Type DefaultValue Description
json object

Relevant data used to restore the ellipse redline element.

importSVG

Imports data from an SVG ellipse element into the ellipse redline element.

Param Type DefaultValue Description
svg object

SVG ellipse element used to restore the ellipse redline element.

setFillColor

Sets a new value for property fillColor.

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

Default value is "rgba(0, 0, 0, 0)".

Param Type DefaultValue Description
sFillColor sap.ui.core.CSSColor "rgba(0, 0, 0, 0)"

New value for property fillColor

setRadiusX

Sets a new value for property radiusX.

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

Default value is 0.0001.

Param Type DefaultValue Description
fRadiusX float 0.0001

New value for property radiusX

setRadiusY

Sets a new value for property radiusY.

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

Default value is 0.0001.

Param Type DefaultValue Description
fRadiusY float 0.0001

New value for property radiusY