.. role:: ts-api-decorator

####################
ArrowGeneratorConfig
####################

.. js:module:: cee.utils
   :noindex:

.. container:: ts-api-section

   .. js:class:: ArrowGeneratorConfig

      The arrow generator configuration object, see ``ArrowGenerator``.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.utils.ArrowGeneratorConfig.headRelativeLength`
   * :js:attr:`~cee.utils.ArrowGeneratorConfig.headRelativeRadius`
   * :js:attr:`~cee.utils.ArrowGeneratorConfig.numSlices`
   * :js:attr:`~cee.utils.ArrowGeneratorConfig.shaftRelativeRadius`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ArrowGeneratorConfig.headRelativeLength

      :type: number :ts-api-decorator:`optional`

      The relative length of the arrow's head compared to the arrow's body (the total length is 1). 
      A value of 0.2 will result in a body that is 0.8 in length.



.. container:: ts-api-section

   .. js:attribute:: ArrowGeneratorConfig.headRelativeRadius

      :type: number :ts-api-decorator:`optional`

      The relative radius of the arrow's head to the arrow's length of 1.



.. container:: ts-api-section

   .. js:attribute:: ArrowGeneratorConfig.numSlices

      :type: number :ts-api-decorator:`optional`

      The number of slices for both the head and the shaft of the arrow. Minimum is 4.



.. container:: ts-api-section

   .. js:attribute:: ArrowGeneratorConfig.shaftRelativeRadius

      :type: number :ts-api-decorator:`optional`

      The relative radius of the arrow's shaft to the arrow's length of 1.



