.. role:: ts-api-decorator

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

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

.. container:: ts-api-section

   .. js:class:: CircleCollection

      This class is useful for specifying multiple circles that all share the same visual appearance.



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Methods

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

   * :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
============

.. container:: ts-api-section

   .. js:function:: CircleCollection.constructor()



      :rtype: CircleCollection



Methods
=======

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

addCircle
---------

.. js:method:: CircleCollection.addCircle( center, radius)

   :param center: circle center
   :type center: Point2
   :param radius: the circle radius
   :type radius: number


   Adds a circle to the collection


   :rtype: void

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

clear
-----

.. js:method:: CircleCollection.clear()



   Removes all circles from this collection


   :rtype: void

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

getCircles
----------

.. js:method:: CircleCollection.getCircles()



   Gets the circles in the collection


   :rtype: [_MarkupCircleData]

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

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

.. js:method:: CircleCollection.getFillColor()



   Gets the fill color for this shape

   :returns: the fill color


   :rtype: Color

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

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

.. js:method:: CircleCollection.getFillOpacity()



   Gets the fill opacity for this shape

   :returns: the fill opacity


   :rtype: number

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

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

.. js:method:: CircleCollection.getStrokeColor()



   Gets the stroke color for this shape

   :returns: the stroke color


   :rtype: Color

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

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

.. js:method:: CircleCollection.getStrokeWidth()



   Gets the stroke width for this shape in pixels

   :returns: the stroke width in pixels


   :rtype: number

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

setCircle
---------

.. js:method:: CircleCollection.setCircle( index, center, radius)

   :param index: the index of the circle to update
   :type index: number
   :param center: circle center
   :type center: Point2
   :param radius: the circle radius
   :type radius: number


   Updates a circle in the collection


   :rtype: void

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

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

.. js:method:: CircleCollection.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:: CircleCollection.setFillOpacity( fillOpacity)

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


   Sets the fill opacity for this shape


   :rtype: void

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

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

.. js:method:: CircleCollection.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:: CircleCollection.setStrokeWidth( strokeWidth)

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


   Sets the stroke width for this shape in pixels


   :rtype: void

