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


################
CircleCollection
################

.. js:class:: Markup.Shapes.CircleCollection

   This class is useful for specifying multiple circles that all share the same visual appearance.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Markup.Shapes.CircleCollection.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Markup.Shapes.CircleCollection.addCircle`
   * :js:meth:`~Markup.Shapes.CircleCollection.clear`
   * :js:meth:`~Markup.Shapes.CircleCollection.getCircles`
   * :js:meth:`~Markup.Shapes.CircleCollection.getFillColor`
   * :js:meth:`~Markup.Shapes.CircleCollection.getFillOpacity`
   * :js:meth:`~Markup.Shapes.CircleCollection.getStrokeColor`
   * :js:meth:`~Markup.Shapes.CircleCollection.getStrokeWidth`
   * :js:meth:`~Markup.Shapes.CircleCollection.setCircle`
   * :js:meth:`~Markup.Shapes.CircleCollection.setFillColor`
   * :js:meth:`~Markup.Shapes.CircleCollection.setFillOpacity`
   * :js:meth:`~Markup.Shapes.CircleCollection.setStrokeColor`
   * :js:meth:`~Markup.Shapes.CircleCollection.setStrokeWidth`
   
   




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

.. js:method:: Markup.Shapes.CircleCollection.constructor

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





Methods
=======

.. js:method:: Markup.Shapes.CircleCollection.addCircle

   .. rst-class:: sig-pretty-signature
   
      | addCircle(**center**\ : :js:class:`~Point2`\ , **radius**\ : *number*\ ): *void*
   
   Adds a circle to the collection
   
   **Parameters**
   
      **center**\ : :js:class:`~Point2`
   
         circle center
   
   
      **radius**\ : *number*
   
         the circle radius
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.CircleCollection.clear

   .. rst-class:: sig-pretty-signature
   
      | clear(): *void*
   
   Removes all circles from this collection
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.CircleCollection.getCircles

   .. rst-class:: sig-pretty-signature
   
      | getCircles(): *_MarkupCircleData*\ []
   
   Gets the circles in the collection
   
   **Returns**\ : *_MarkupCircleData*\ []
   



.. js:method:: Markup.Shapes.CircleCollection.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.CircleCollection.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.CircleCollection.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.CircleCollection.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.CircleCollection.setCircle

   .. rst-class:: sig-pretty-signature
   
      | setCircle(**index**\ : *number*\ , **center**\ : :js:class:`~Point2`\ , **radius**\ : *number*\ ): *void*
   
   Updates a circle in the collection
   
   **Parameters**
   
      **index**\ : *number*
   
         the index of the circle to update
   
   
      **center**\ : :js:class:`~Point2`
   
         circle center
   
   
      **radius**\ : *number*
   
         the circle radius
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.CircleCollection.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.CircleCollection.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.CircleCollection.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.CircleCollection.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*
   





