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


#################
PolygonCollection
#################

.. js:class:: wv.Markup.Shapes.PolygonCollection

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



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: wv.Markup.Shapes.PolygonCollection.constructor

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



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wv.Markup.Shapes.PolygonCollection.clear

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



.. js:method:: wv.Markup.Shapes.PolygonCollection.createPolygon

      .. rst-class:: sig-pretty-signature
      
         | createPolygon(): :js:class:`Point2 <wv.Point2>`\ []
      
      Creates a new array of points that represent a polygon. Add Point2 objects to the array to construct the polygon
      
      **Returns**\ : :js:class:`Point2 <wv.Point2>`\ []
      
      
         new array which represents a polygon.
      
      



.. js:method:: wv.Markup.Shapes.PolygonCollection.getFillColor

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



.. js:method:: wv.Markup.Shapes.PolygonCollection.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:: wv.Markup.Shapes.PolygonCollection.getPolygons

      .. rst-class:: sig-pretty-signature
      
         | getPolygons(): :js:class:`Point2 <wv.Point2>`\ [][]
      
      **Returns**\ : :js:class:`Point2 <wv.Point2>`\ [][]
      
      
         the polylines in this collection
      
      



.. js:method:: wv.Markup.Shapes.PolygonCollection.getStrokeColor

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



.. js:method:: wv.Markup.Shapes.PolygonCollection.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:: wv.Markup.Shapes.PolygonCollection.setFillColor

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



.. js:method:: wv.Markup.Shapes.PolygonCollection.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:: wv.Markup.Shapes.PolygonCollection.setStrokeColor

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



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




