class sap.ui.vk.RedlineElementLine

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

Provides a control for creating line redline elements.


Constructor

Redline element control for line.

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

Properties

Name Type Default Value Description
deltaX float 0 Visibility: public
deltaY float 0 Visibility: public
endArrowHead boolean false 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 deltaX and deltaY of the line redline element by a factor which gets passed as parameter.

edit

Changes the current deltaX and deltaY of the line redline element with the values passed as parameters.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementLine.extend

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

getDeltaX

Gets current value of property deltaX.

Default value is 0.

getDeltaY

Gets current value of property deltaY.

Default value is 0.

getEndArrowHead

Gets current value of property endArrowHead.

Default value is false.

sap.ui.vk.RedlineElementLine.getMetadata

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

importJSON

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

importSVG

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

setDeltaX

Sets a new value for property deltaX.

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

Default value is 0.

setDeltaY

Sets a new value for property deltaY.

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

Default value is 0.

setEndArrowHead

Sets a new value for property endArrowHead.

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

Default value is false.

applyZoom

Changes the current deltaX and deltaY of the line redline element by a factor which gets passed as parameter.

Param Type DefaultValue Description
zoomBy number

The factor to be applied to the current deltaX and deltaY.

edit

Changes the current deltaX and deltaY of the line redline element with the values passed as parameters.

Param Type DefaultValue Description
offsetX number

The value in pixels that will be set as deltaX for the line.

offsetY number

The value in pixels that will be set as deltaY for the line.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementLine.extend

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

getDeltaX

Gets current value of property deltaX.

Default value is 0.

getDeltaY

Gets current value of property deltaY.

Default value is 0.

getEndArrowHead

Gets current value of property endArrowHead.

Default value is false.

sap.ui.vk.RedlineElementLine.getMetadata

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

importJSON

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

Param Type DefaultValue Description
json object

Relevant data used to restore the line redline element.

importSVG

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

Param Type DefaultValue Description
svg object

SVG line element used to restore the line redline element.

setDeltaX

Sets a new value for property deltaX.

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

Default value is 0.

Param Type DefaultValue Description
fDeltaX float 0

New value for property deltaX

setDeltaY

Sets a new value for property deltaY.

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

Default value is 0.

Param Type DefaultValue Description
fDeltaY float 0

New value for property deltaY

setEndArrowHead

Sets a new value for property endArrowHead.

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

Default value is false.

Param Type DefaultValue Description
bEndArrowHead boolean false

New value for property endArrowHead