class sap.ui.vk.RedlineElementFreehand

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

Provides a control for creating freehand redline elements.


Constructor

Redline element control for freehand.

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

Properties

Name Type Default Value Description
path float[] 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
_getProcessedPath

Creates a string path based on the current path property. The string path can then be used to set the "d" attribute of an SVG element.

applyZoom

Applies a zoom factor to the current freehand redline element.

edit

Adds a new point to the current freehand path.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementFreehand.extend

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

sap.ui.vk.RedlineElementFreehand.getMetadata

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

getPath

Gets current value of property path.

importJSON

Imports data from JSON into the redline element.

importSVG

Imports data from SVG path element into the freehand redline element.

setPath

Sets a new value for property path.

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

_getProcessedPath

Creates a string path based on the current path property. The string path can then be used to set the "d" attribute of an SVG element.

applyZoom

Applies a zoom factor to the current freehand redline element.

Param Type DefaultValue Description
zoomBy number

The factor to be applied to the current freehand drawing.

edit

Adds a new point to the current freehand path.

Param Type DefaultValue Description
offsetX number

The value in pixels that will be set as the origin of the x-coordinate for a new point in the freehand path.

offsetY number

The value in pixels that will be set as the origin of the y-coordinate for a new point in the freehand path.

exportJSON

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

exportSVG

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

sap.ui.vk.RedlineElementFreehand.extend

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

sap.ui.vk.RedlineElementFreehand.getMetadata

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

getPath

Gets current value of property path.

importJSON

Imports data from JSON into the redline element.

Param Type DefaultValue Description
json object

Relevant data that can be used to restore the freehand redline element.

importSVG

Imports data from SVG path element into the freehand redline element.

Param Type DefaultValue Description
svg object

SVG path element that can be used to restore the freehand redline element.

setPath

Sets a new value for property path.

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

Param Type DefaultValue Description
sPath float[]

New value for property path