.. role:: ts-api-decorator

######
Circle
######

.. js:module:: Markup.Shapes
   :noindex:

.. container:: ts-api-section

   .. js:class:: Circle

      This class represents a single circle consisting of a center point and a radius.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Markup.Shapes.Circle.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Markup.Shapes.Circle.getCenter`
   * :js:meth:`~Markup.Shapes.Circle.getFillColor`
   * :js:meth:`~Markup.Shapes.Circle.getFillOpacity`
   * :js:meth:`~Markup.Shapes.Circle.getRadius`
   * :js:meth:`~Markup.Shapes.Circle.getStrokeColor`
   * :js:meth:`~Markup.Shapes.Circle.getStrokeWidth`
   * :js:meth:`~Markup.Shapes.Circle.set`
   * :js:meth:`~Markup.Shapes.Circle.setCenter`
   * :js:meth:`~Markup.Shapes.Circle.setFillColor`
   * :js:meth:`~Markup.Shapes.Circle.setFillOpacity`
   * :js:meth:`~Markup.Shapes.Circle.setRadius`
   * :js:meth:`~Markup.Shapes.Circle.setStrokeColor`
   * :js:meth:`~Markup.Shapes.Circle.setStrokeWidth`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: Circle.constructor()



      :rtype: Circle



Methods
=======

.. rst-class:: ts-api-section

getCenter
---------

.. js:method:: Circle.getCenter()



   Gets the center of the circle

   :returns: the circle center


   :rtype: Point2

.. rst-class:: ts-api-section

getFillColor
------------

.. js:method:: Circle.getFillColor()



   Gets the fill color for this shape

   :returns: the fill color


   :rtype: Color

.. rst-class:: ts-api-section

getFillOpacity
--------------

.. js:method:: Circle.getFillOpacity()



   Gets the fill opacity for this shape

   :returns: the fill opacity


   :rtype: number

.. rst-class:: ts-api-section

getRadius
---------

.. js:method:: Circle.getRadius()



   Gets the radius of the circle

   :returns: the circle radius


   :rtype: number

.. rst-class:: ts-api-section

getStrokeColor
--------------

.. js:method:: Circle.getStrokeColor()



   Gets the stroke color for this shape

   :returns: the stroke color


   :rtype: Color

.. rst-class:: ts-api-section

getStrokeWidth
--------------

.. js:method:: Circle.getStrokeWidth()



   Gets the stroke width for this shape in pixels

   :returns: the stroke width in pixels


   :rtype: number

.. rst-class:: ts-api-section

set
---

.. js:method:: Circle.set( center, radius)

   :param center: the center point of the circle.
   :type center: Point2
   :param radius: None
   :type radius: number


   Sets the values for the circle

   :radius: the circle radius.


   :rtype: void

.. rst-class:: ts-api-section

setCenter
---------

.. js:method:: Circle.setCenter( center)

   :param center: None
   :type center: Point2


   Sets the center of the circle


   :rtype: void

.. rst-class:: ts-api-section

setFillColor
------------

.. js:method:: Circle.setFillColor( color)

   :param color: the fill color
   :type color: Color


   Sets the fill color for this shape


   :rtype: void

.. rst-class:: ts-api-section

setFillOpacity
--------------

.. js:method:: Circle.setFillOpacity( fillOpacity)

   :param fillOpacity: the fill opacity
   :type fillOpacity: number


   Sets the fill opacity for this shape


   :rtype: void

.. rst-class:: ts-api-section

setRadius
---------

.. js:method:: Circle.setRadius( radius)

   :param radius: the circle radius
   :type radius: number


   Sets the radius of the circle


   :rtype: void

.. rst-class:: ts-api-section

setStrokeColor
--------------

.. js:method:: Circle.setStrokeColor( color)

   :param color: the stroke color
   :type color: Color


   Sets the stroke color for this shape


   :rtype: void

.. rst-class:: ts-api-section

setStrokeWidth
--------------

.. js:method:: Circle.setStrokeWidth( strokeWidth)

   :param strokeWidth: the stroke width in pixels
   :type strokeWidth: number


   Sets the stroke width for this shape in pixels


   :rtype: void

