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


###################
RectangleCollection
###################

.. js:class:: Markup.Shapes.RectangleCollection

   This is useful for drawing a number of rectangles which share the same visual appearance.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Markup.Shapes.RectangleCollection.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Markup.Shapes.RectangleCollection.addRectangle`
   * :js:meth:`~Markup.Shapes.RectangleCollection.clear`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getBorderRadius`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getFillColor`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getFillOpacity`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getRectangles`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getStrokeColor`
   * :js:meth:`~Markup.Shapes.RectangleCollection.getStrokeWidth`
   * :js:meth:`~Markup.Shapes.RectangleCollection.setBorderRadius`
   * :js:meth:`~Markup.Shapes.RectangleCollection.setFillColor`
   * :js:meth:`~Markup.Shapes.RectangleCollection.setFillOpacity`
   * :js:meth:`~Markup.Shapes.RectangleCollection.setStrokeColor`
   * :js:meth:`~Markup.Shapes.RectangleCollection.setStrokeWidth`
   
   




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

.. js:method:: Markup.Shapes.RectangleCollection.constructor

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





Methods
=======

.. js:method:: Markup.Shapes.RectangleCollection.addRectangle

   .. rst-class:: sig-pretty-signature
   
      | addRectangle(**position**\ : :js:class:`~Point2`\ , **size**\ : :js:class:`~Point2`\ ): *void*
   
   Adds a rectangle to the collection
   
   **Parameters**
   
      **position**\ : :js:class:`~Point2`
   
         the top left corner of the rectangle
   
   
      **size**\ : :js:class:`~Point2`
   
         indicating the rectangle width and height
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.RectangleCollection.clear

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



.. js:method:: Markup.Shapes.RectangleCollection.getBorderRadius

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



.. js:method:: Markup.Shapes.RectangleCollection.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.RectangleCollection.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.RectangleCollection.getRectangles

   .. rst-class:: sig-pretty-signature
   
      | getRectangles(): *_MarkupRectangleData*\ []
   
   Gets the rectangles in the collection
   
   **Returns**\ : *_MarkupRectangleData*\ []
   



.. js:method:: Markup.Shapes.RectangleCollection.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.RectangleCollection.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.RectangleCollection.setBorderRadius

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setBorderRadius(**borderRadius**\ : *number*\ ): *void*
   
   Sets the border radius for this shape
   
   **Parameters**
   
      **borderRadius**\ : *number*
   
         the border radius in pixels
   
   
   
   **Returns**\ : *void*
   



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





