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


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

.. js:class:: 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:`~Markup.Shapes.TextCollection.addString`
   * :js:meth:`~Markup.Shapes.TextCollection.clear`
   * :js:meth:`~Markup.Shapes.TextCollection.getFillColor`
   * :js:meth:`~Markup.Shapes.TextCollection.getFillOpacity`
   * :js:meth:`~Markup.Shapes.TextCollection.getFontFamily`
   * :js:meth:`~Markup.Shapes.TextCollection.getFontSize`
   * :js:meth:`~Markup.Shapes.TextCollection.getStrings`
   * :js:meth:`~Markup.Shapes.TextCollection.getStrokeColor`
   * :js:meth:`~Markup.Shapes.TextCollection.getStrokeWidth`
   * :js:meth:`~Markup.Shapes.TextCollection.setFillColor`
   * :js:meth:`~Markup.Shapes.TextCollection.setFillOpacity`
   * :js:meth:`~Markup.Shapes.TextCollection.setFontFamily`
   * :js:meth:`~Markup.Shapes.TextCollection.setFontSize`
   * :js:meth:`~Markup.Shapes.TextCollection.setStrokeColor`
   * :js:meth:`~Markup.Shapes.TextCollection.setStrokeWidth`
   
   




Methods
=======

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

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



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

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



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

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



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





