# Class: Circle

## Constructor

#### new Circle(topLeft, bottomRight, ownerDisplayName, filled, isMine, color, alpha, width)

  Circle extends AvayaClientServices.Services.Collaboration.AbstractShape. Circle radius and position are
  stored as two points (top left and bottom right) of a rectangle surrounding a circle.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `topLeft` | AvayaClientServices.Services.Collaboration.Point |
  `bottomRight` | AvayaClientServices.Services.Collaboration.Point |
  `ownerDisplayName` | string |
  `filled` | boolean |
  `isMine` | boolean |
  `color` | string |
  `alpha` | number |
  `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)> }

#### getAlpha() → {Number}

  Gets an alpha of the shape.
  The alpha channel controls the transparency or opacity of a color.
  Its value is represented as an integer: full transparency is 0, whereas full opacity is 100.

  ##### Returns:

  { Number }

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

  Gets the bottom right point of a rectangle surrounding a circle.

  ##### Returns:

  { AvayaClientServices.Services.Collaboration.Point }

  Bottom right point.

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

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

#### getPrimitiveShapeSize()

  Returns the primitive shape size of circle.

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

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

  Gets the top left point of a rectangle surrounding a circle.

  ##### Returns:

  { AvayaClientServices.Services.Collaboration.Point }

  Top left point.

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

#### isFilled() → {Boolean}

  Determines whether the circle is filled or not.

  ##### Returns:

  { Boolean }

  Returns true if circle is filled, false otherwise.

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

#### setBottomRight(bottomRight)

  Sets the bottom right point of a rectangle surrounding a circle.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `bottomRight` | AvayaClientServices.Services.Collaboration.Point | Bottom right point.

#### setTopLeft(topLeft)

  Sets the top left point of a rectangle surrounding a circle.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `topLeft` | AvayaClientServices.Services.Collaboration.Point | Top left point.

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