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


##############
TextCollection
##############

.. js:class:: wv.Markup.Shapes.TextCollection

   This is a base class for text markup objects. It should not be created directly.
   
   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Markup.Shapes.TextCollection.addString`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.clear`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getFillColor`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getFillOpacity`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getFontFamily`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getFontSize`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getStrings`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getStrokeColor`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.getStrokeWidth`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setFillColor`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setFillOpacity`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setFontFamily`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setFontSize`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setStrokeColor`
   * :js:meth:`~wv.Markup.Shapes.TextCollection.setStrokeWidth`
   
   



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

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


.. js:method:: wv.Markup.Shapes.TextCollection.addString

      .. rst-class:: sig-pretty-signature
      
         | addString(**text**\ : *string*\ , **position**\ : :js:class:`Point2 <wv.Point2>`\ ): *void*
      
      Adds a string to the collection
      
      **Parameters**
      
      
         **text**\ : *string*
      
      
            the text to render
      
      
         **position**\ : :js:class:`Point2 <wv.Point2>`
      
      
            the top left position of the text
      
      
      
      **Returns**\ : *void*
      



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

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



.. js:method:: wv.Markup.Shapes.TextCollection.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.TextCollection.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.TextCollection.getFontFamily

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getFontFamily(): (*None* | *string*\ )
      
      Gets the font family for this text
      
      **Returns**\ : (*None* \| *string*\ )
      
      
         the font family
      
      



.. js:method:: wv.Markup.Shapes.TextCollection.getFontSize

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getFontSize(): *number*
      
      Gets the font size for this text
      
      **Returns**\ : *number*
      
      
         the font size
      
      



.. js:method:: wv.Markup.Shapes.TextCollection.getStrings

      .. rst-class:: sig-pretty-signature
      
         | getStrings(): *_MarkupTextData*\ []
      
      Gets the strings in the collection
      
      **Returns**\ : *_MarkupTextData*\ []
      



.. js:method:: wv.Markup.Shapes.TextCollection.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.TextCollection.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.TextCollection.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.TextCollection.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.TextCollection.setFontFamily

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setFontFamily(**fontFamily**\ : *string*\ ): *void*
      
      Sets the font family this shape
      
      **Parameters**
      
      
         **fontFamily**\ : *string*
      
      
            font family to use for this text
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Markup.Shapes.TextCollection.setFontSize

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setFontSize(**fontSize**\ : *number*\ ): *void*
      
      Sets the font size for this text
      
      **Parameters**
      
      
         **fontSize**\ : *number*
      
      
            size to use for this text
      
      
      
      **Returns**\ : *void*
      



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




