# Class: WhiteboardText

## 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:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_color

#### <protected> _id :number

  Shape unique id.

  ##### Type:

  - number
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_id

#### <protected> _isMine :boolean

  Determines whether the shape belongs to the current user.

  ##### Type:

  - boolean
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_isMine

#### <protected> _ownerDisplayName :string

  Display name of the shape owner.

  ##### Type:

  - string
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_ownerDisplayName

#### <protected> _primitiveShapeSize :Number|undefined

  Size of primitive shape

  ##### Type:

  - Number | undefined
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_primitiveShapeSize

#### <protected> _status :AvayaClientServices.Services.Collaboration.SelectionStatus

  Shape status as defined in AvayaClientServices.Services.Collaboration.SelectionStatus.

  ##### Type:

  - AvayaClientServices.Services.Collaboration.SelectionStatus
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_status

#### <protected> _translation :AvayaClientServices.Services.Collaboration.Point

  Shape position.

  ##### Type:

  - AvayaClientServices.Services.Collaboration.Point
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_translation

#### <protected> _width :number

  Shape width.

  ##### Type:

  - number
  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#_width

## 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.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#finishDrawing

  ##### 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.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getColor

  ##### 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:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getId

  ##### Returns:

  { String }

#### getOwnerDisplayName() → {String}

  Returns the name of the user who created the shape.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getOwnerDisplayName

  ##### Returns:

  { String }

#### getPosition() → {AvayaClientServices.Services.Collaboration.Point}

  Returns the position of the text on the whiteboard surface.

  ##### Returns:

  { AvayaClientServices.Services.Collaboration.Point }

#### getPrimitiveShapeSize()

  Returns the primitive shape size of whiteboard text.

#### getStatus() → {AvayaClientServices.Services.Collaboration.SelectionStatus}

  Gets shape status as defined in AvayaClientServices.Services.Collaboration.SelectionStatus.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getStatus

  ##### 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.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getTranslation

  ##### Returns:

  { AvayaClientServices.Services.Collaboration.Point }

#### getWidth() → {Number}

  Returns shape width.
  Value in pixels.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#getWidth

  ##### Returns:

  { Number }

  Width of shape.

#### isFinished() → {boolean}

  Determines whether drawing of shape has been finished.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#isFinished

  ##### Returns:

  { boolean }

#### isMine() → {Boolean}

  Determines whether the shape has been created by the local user.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#isMine

  ##### 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.

  Inherited From:
    - AvayaClientServices.Services.Collaboration.AbstractShape#setTranslation

  ##### Returns:

  { void }