class sap.ui.vk.RedlineElementRectangle

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

Provides a control for creating rectangle redline elements.


Constructor

Redline element control for rectangle.

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.RedlineElementRectangle()

Properties

Name Type Default Value Description
fillColor sap.ui.core.CSSColor rgba(0, 0, 0, 0) Visibility: public
height float 0.001 Visibility: public
width float 0.001 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 width and height of the rectangle redline element by a factor which gets passed as parameter.

edit

Changes the current width and height of the rectangle redline element with the values passed as parameters.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementRectangle.extend

Creates a new subclass of class sap.ui.vk.RedlineElementRectangle 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)".

getHeight

Gets current value of property height.

Default value is 0.001.

sap.ui.vk.RedlineElementRectangle.getMetadata

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

getWidth

Gets current value of property width.

Default value is 0.001.

importJSON

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

importSVG

Imports data from an SVG rect element into the rectangle 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)".

setHeight

Sets a new value for property height.

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

Default value is 0.001.

setWidth

Sets a new value for property width.

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

Default value is 0.001.

applyZoom

Changes the current width and height of the rectangle redline element by a factor which gets passed as parameter.

Param Type DefaultValue Description
zoomBy number

The factor to be applied to the current width and height.

edit

Changes the current width and height of the rectangle redline element with the values passed as parameters.

Param Type DefaultValue Description
offsetX number

The value in pixels that will be set as the width for the rectangle redline element.

offsetY number

The value in pixels that will be set as the height for the rectangle redline element.

isSquare boolean

True if the element is square False/Undefined otherwise.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementRectangle.extend

Creates a new subclass of class sap.ui.vk.RedlineElementRectangle 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)".

getHeight

Gets current value of property height.

Default value is 0.001.

sap.ui.vk.RedlineElementRectangle.getMetadata

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

getWidth

Gets current value of property width.

Default value is 0.001.

importJSON

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

Param Type DefaultValue Description
json object

Relevant data used to restore the rectangle redline element.

importSVG

Imports data from an SVG rect element into the rectangle redline element.

Param Type DefaultValue Description
svg object

SVG rect element used to restore the rectangle 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

setHeight

Sets a new value for property height.

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

Default value is 0.001.

Param Type DefaultValue Description
fHeight float 0.001

New value for property height

setWidth

Sets a new value for property width.

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

Default value is 0.001.

Param Type DefaultValue Description
fWidth float 0.001

New value for property width