Constructor
-
new WhiteboardText(content, fontSize, ownerDisplayName, filled, isMine, color, width)
-
Whiteboard text extends AvayaClientServices.Services.Collaboration.AbstractShape. It contains
the text content and properties.Parameters:
Name Type Description content
string fontSize
number ownerDisplayName
string filled
boolean isMine
boolean color
string width
number
Members
-
<protected> _color :number
-
Color in HEX translated to DEC.
Type:
- number
- Inherited From:
-
<protected> _id :number
-
Shape unique id.
Type:
- number
- Inherited From:
-
<protected> _isMine :boolean
-
Determines whether the shape belongs to the current user.
Type:
- boolean
- Inherited From:
-
<protected> _ownerDisplayName :string
-
Display name of the shape owner.
Type:
- string
-
<protected> _primitiveShapeSize :Number|undefined
-
Size of primitive shape
Type:
- Number | undefined
-
<protected> _status :AvayaClientServices.Services.Collaboration.SelectionStatus
-
Shape status as defined in AvayaClientServices.Services.Collaboration.SelectionStatus.
Type:
- Inherited From:
-
<protected> _translation :AvayaClientServices.Services.Collaboration.Point
-
Shape position.
Type:
-
<protected> _width :number
-
Shape width.
Type:
- number
- Inherited From:
Methods
-
finishDrawing() → {AvayaClientServices.Base.Promise.<(Boolean|Undefined)>}
-
Finishes drawing process.
When user draws on whiteboard, this function is being invoked both at the end of live drawing tool, rectangle and polygon tool.
When user receives whiteboard sharing, this function is being invoked at the end of live drawing tool.Returns:
{ AvayaClientServices.Base.Promise.<(Boolean|Undefined)> }
-
getColor() → {Number}
-
Returns the shape color as a decimal number. When converted to hexadecimal, it's standard HEX color.
Returns:
{ Number }
-
getContent() → {String}
-
Gets the text content.
Returns:
{ String }
-
getFontSize() → {number}
-
Gets the text font size. Value in pixels.
Returns:
{ number }
-
getId() → {String}
-
Returns shape id.
- Inherited From:
Returns:
{ String }
-
getOwnerDisplayName() → {String}
-
Returns the name of the user who created the shape.
Returns:
{ String }
-
getPosition() → {AvayaClientServices.Services.Collaboration.Point}
-
Returns the position of the text on the whiteboard surface.
Returns:
-
getPrimitiveShapeSize()
-
Returns the primitive shape size of whiteboard text.
-
getStatus() → {AvayaClientServices.Services.Collaboration.SelectionStatus}
-
Gets shape status as defined in AvayaClientServices.Services.Collaboration.SelectionStatus.
Returns:
{ AvayaClientServices.Services.Collaboration.SelectionStatus }Shape status.
-
getTranslation() → {AvayaClientServices.Services.Collaboration.Point}
-
Returns shape translation (position).
Translation is an offset value relative to the first position of the shape.Returns:
-
getWidth() → {Number}
-
Returns shape width.
Value in pixels.Returns:
{ Number }Width of shape.
-
isFinished() → {boolean}
-
Determines whether drawing of shape has been finished.
Returns:
{ boolean }
-
isMine() → {Boolean}
-
Determines whether the shape has been created by the local user.
- Inherited From:
Returns:
{ Boolean }Returns true if the shape belongs to the local user, false otherwise.
-
setPosition(point) → {void}
-
Sets the text position.
Parameters:
Name Type Description point
AvayaClientServices.Services.Collaboration.Point New text position
Returns:
{ void }
-
setTranslation(point) → {void}
-
Sets shape translation (position).
Sets the new offset value relative to the first position of the shape.Parameters:
Name Type Description point
AvayaClientServices.Services.Collaboration.Point New position of shape.
Returns:
{ void }