.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: cee.utils.ArrowGeneratorConfig

   The arrow generator configuration object, see :js:class:`ArrowGenerator <cee.utils.ArrowGenerator>`\ .
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.utils.ArrowGeneratorConfig.headRelativeLength`
   * :js:data:`~cee.utils.ArrowGeneratorConfig.headRelativeRadius`
   * :js:data:`~cee.utils.ArrowGeneratorConfig.numSlices`
   * :js:data:`~cee.utils.ArrowGeneratorConfig.shaftRelativeRadius`
   
   



.. rst-class:: kind-group kind-properties

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


.. js:data:: cee.utils.ArrowGeneratorConfig.headRelativeLength

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | headRelativeLength: *number*
      
      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.
      



.. js:data:: cee.utils.ArrowGeneratorConfig.headRelativeRadius

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | headRelativeRadius: *number*
      
      The relative radius of the arrow's head to the arrow's length of 1.
      



.. js:data:: cee.utils.ArrowGeneratorConfig.numSlices

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | numSlices: *number*
      
      The number of slices for both the head and the shaft of the arrow. Minimum is 4.
      



.. js:data:: cee.utils.ArrowGeneratorConfig.shaftRelativeRadius

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | shaftRelativeRadius: *number*
      
      The relative radius of the arrow's shaft to the arrow's length of 1.
      




