.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


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

.. js:class:: Markup.Shapes.Circle

   This class represents a single circle consisting of a center point and a radius.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Markup.Shapes.Circle.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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
============

.. js:method:: Markup.Shapes.Circle.constructor

   .. rst-class:: sig-pretty-signature
   
      | Circle(): :js:class:`Circle <Markup.Shapes.Circle>`
   
   **Returns**\ : :js:class:`Circle <Markup.Shapes.Circle>`
   





Methods
=======

.. js:method:: Markup.Shapes.Circle.getCenter

   .. rst-class:: sig-pretty-signature
   
      | getCenter(): :js:class:`~Point2`
   
   Gets the center of the circle
   
   **Returns**\ : :js:class:`~Point2`
   
      the circle center
   
   



.. js:method:: Markup.Shapes.Circle.getFillColor

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getFillColor(): :js:class:`~Color`
   
   Gets the fill color for this shape
   
   **Returns**\ : :js:class:`~Color`
   
      the fill color
   
   



.. js:method:: Markup.Shapes.Circle.getFillOpacity

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getFillOpacity(): *number*
   
   Gets the fill opacity for this shape
   
   **Returns**\ : *number*
   
      the fill opacity
   
   



.. js:method:: Markup.Shapes.Circle.getRadius

   .. rst-class:: sig-pretty-signature
   
      | getRadius(): *number*
   
   Gets the radius of the circle
   
   **Returns**\ : *number*
   
      the circle radius
   
   



.. js:method:: Markup.Shapes.Circle.getStrokeColor

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getStrokeColor(): :js:class:`~Color`
   
   Gets the stroke color for this shape
   
   **Returns**\ : :js:class:`~Color`
   
      the stroke color
   
   



.. js:method:: Markup.Shapes.Circle.getStrokeWidth

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getStrokeWidth(): *number*
   
   Gets the stroke width for this shape in pixels
   
   **Returns**\ : *number*
   
      the stroke width in pixels
   
   



.. js:method:: Markup.Shapes.Circle.set

   .. rst-class:: sig-pretty-signature
   
      | set(**center**\ : :js:class:`~Point2`\ , **radius**\ : *number*\ ): *void*
   
   Sets the values for the circle
   
   **Parameters**
   
      **center**\ : :js:class:`~Point2`
   
         the center point of the circle.
   
   
      **radius**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setCenter

   .. rst-class:: sig-pretty-signature
   
      | setCenter(**center**\ : :js:class:`~Point2`\ ): *void*
   
   Sets the center of the circle
   
   **Parameters**
   
      **center**\ : :js:class:`~Point2`
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setFillColor

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setFillColor(**color**\ : :js:class:`~Color`\ ): *void*
   
   Sets the fill color for this shape
   
   **Parameters**
   
      **color**\ : :js:class:`~Color`
   
         the fill color
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setFillOpacity

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setFillOpacity(**fillOpacity**\ : *number*\ ): *void*
   
   Sets the fill opacity for this shape
   
   **Parameters**
   
      **fillOpacity**\ : *number*
   
         the fill opacity
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setRadius

   .. rst-class:: sig-pretty-signature
   
      | setRadius(**radius**\ : *number*\ ): *void*
   
   Sets the radius of the circle
   
   **Parameters**
   
      **radius**\ : *number*
   
         the circle radius
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setStrokeColor

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setStrokeColor(**color**\ : :js:class:`~Color`\ ): *void*
   
   Sets the stroke color for this shape
   
   **Parameters**
   
      **color**\ : :js:class:`~Color`
   
         the stroke color
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.Circle.setStrokeWidth

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setStrokeWidth(**strokeWidth**\ : *number*\ ): *void*
   
   Sets the stroke width for this shape in pixels
   
   **Parameters**
   
      **strokeWidth**\ : *number*
   
         the stroke width in pixels
   
   
   
   **Returns**\ : *void*
   





