.. role:: ts-api-decorator

###########
EndcapShape
###########

.. js:module:: Markup.Shapes
   :noindex:

.. container:: ts-api-section

   .. js:class:: EndcapShape



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Markup.Shapes.EndcapShape.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Markup.Shapes.EndcapShape.getEndEndcapColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.getEndEndcapSize`
   * :js:meth:`~Markup.Shapes.EndcapShape.getEndEndcapType`
   * :js:meth:`~Markup.Shapes.EndcapShape.getEndcapsInverted`
   * :js:meth:`~Markup.Shapes.EndcapShape.getStartEndcapColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.getStartEndcapSize`
   * :js:meth:`~Markup.Shapes.EndcapShape.getStartEndcapType`
   * :js:meth:`~Markup.Shapes.EndcapShape.getStrokeColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.getStrokeWidth`
   * :js:meth:`~Markup.Shapes.EndcapShape.setEndEndcapColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.setEndEndcapSize`
   * :js:meth:`~Markup.Shapes.EndcapShape.setEndEndcapType`
   * :js:meth:`~Markup.Shapes.EndcapShape.setEndcapType`
   * :js:meth:`~Markup.Shapes.EndcapShape.setEndcapsInverted`
   * :js:meth:`~Markup.Shapes.EndcapShape.setStartEndcapColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.setStartEndcapSize`
   * :js:meth:`~Markup.Shapes.EndcapShape.setStartEndcapType`
   * :js:meth:`~Markup.Shapes.EndcapShape.setStrokeColor`
   * :js:meth:`~Markup.Shapes.EndcapShape.setStrokeWidth`





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

Constructors
============

.. container:: ts-api-section

   .. js:function:: EndcapShape.constructor()



      :rtype: EndcapShape



Methods
=======

.. rst-class:: ts-api-section

getEndEndcapColor
-----------------

.. js:method:: EndcapShape.getEndEndcapColor()



   Gets the color of the end endcap. Default value is black.

   :returns: color for the end endcap.


   :rtype: Color

.. rst-class:: ts-api-section

getEndEndcapSize
----------------

.. js:method:: EndcapShape.getEndEndcapSize()



   Gets the size of the end endcap in pixels. Default value is 9.

   :returns: size of the end endcap.


   :rtype: number

.. rst-class:: ts-api-section

getEndEndcapType
----------------

.. js:method:: EndcapShape.getEndEndcapType()



   Gets the end endcap type for this shape. The default value is none.

   :returns: the end endcap type


   :rtype: EndcapType

.. rst-class:: ts-api-section

getEndcapsInverted
------------------

.. js:method:: EndcapShape.getEndcapsInverted()



   Gets whether endcaps are inverted for this shape. The default value is false.

   :returns: value indicating whether endcaps are inverted


   :rtype: boolean

.. rst-class:: ts-api-section

getStartEndcapColor
-------------------

.. js:method:: EndcapShape.getStartEndcapColor()



   Gets the color of the start endcap. Default value is black.

   :returns: color for the start endcap.


   :rtype: Color

.. rst-class:: ts-api-section

getStartEndcapSize
------------------

.. js:method:: EndcapShape.getStartEndcapSize()



   Gets the size of the start endcap in pixels. Default value is 9.

   :returns: size of the start endcap.


   :rtype: number

.. rst-class:: ts-api-section

getStartEndcapType
------------------

.. js:method:: EndcapShape.getStartEndcapType()



   Gets the start endcap type for this shape. The default Value is none.

   :returns: the start endcap type


   :rtype: EndcapType

.. rst-class:: ts-api-section

getStrokeColor
--------------

.. js:method:: EndcapShape.getStrokeColor()



   Gets the stroke color for this shape

   :returns: the stroke color


   :rtype: Color

.. rst-class:: ts-api-section

getStrokeWidth
--------------

.. js:method:: EndcapShape.getStrokeWidth()



   Gets the stroke width for this shape in pixels

   :returns: the stroke width in pixels


   :rtype: number

.. rst-class:: ts-api-section

setEndEndcapColor
-----------------

.. js:method:: EndcapShape.setEndEndcapColor( color)

   :param color: the end endcap color value.
   :type color: Color


   Sets the color for the end endcap.


   :rtype: void

.. rst-class:: ts-api-section

setEndEndcapSize
----------------

.. js:method:: EndcapShape.setEndEndcapSize( size)

   :param size: the end endcap.
   :type size: number


   Sets the size of the end endcap in pixels.


   :rtype: void

.. rst-class:: ts-api-section

setEndEndcapType
----------------

.. js:method:: EndcapShape.setEndEndcapType( endcapType)

   :param endcapType: the new endcap type
   :type endcapType: EndcapType


   Sets the end endcap type for this shape


   :rtype: void

.. rst-class:: ts-api-section

setEndcapType
-------------

.. js:method:: EndcapShape.setEndcapType( endcapType)

   :param endcapType: the new endcap type
   :type endcapType: EndcapType


   Convenience for setting the start and eend endcap type for this shape


   :rtype: void

.. rst-class:: ts-api-section

setEndcapsInverted
------------------

.. js:method:: EndcapShape.setEndcapsInverted( inverted)

   :param inverted: value indicated whether endcaps should be inverted
   :type inverted: boolean


   Sets whether endcapsare inverted for this shape.


   :rtype: void

.. rst-class:: ts-api-section

setStartEndcapColor
-------------------

.. js:method:: EndcapShape.setStartEndcapColor( color)

   :param color: the start endcap color value.
   :type color: Color


   Sets the color for the start endcap.


   :rtype: void

.. rst-class:: ts-api-section

setStartEndcapSize
------------------

.. js:method:: EndcapShape.setStartEndcapSize( size)

   :param size: the start endcap.
   :type size: number


   Sets the size of the start endcap in pixels.


   :rtype: void

.. rst-class:: ts-api-section

setStartEndcapType
------------------

.. js:method:: EndcapShape.setStartEndcapType( endcapType)

   :param endcapType: the new endcap type
   :type endcapType: EndcapType


   Sets the start endcap type for this shape


   :rtype: void

.. rst-class:: ts-api-section

setStrokeColor
--------------

.. js:method:: EndcapShape.setStrokeColor( color)

   :param color: the stroke color
   :type color: Color


   Sets the stroke color for this shape


   :rtype: void

.. rst-class:: ts-api-section

setStrokeWidth
--------------

.. js:method:: EndcapShape.setStrokeWidth( strokeWidth)

   :param strokeWidth: the stroke width in pixels
   :type strokeWidth: number


   Sets the stroke width for this shape in pixels


   :rtype: void

