ducpy.utils.ElementTypes
========================

.. py:module:: ducpy.utils.ElementTypes


Attributes
----------

.. autoapisummary::

   ducpy.utils.ElementTypes.StrokeStyle


Classes
-------

.. autoapisummary::

   ducpy.utils.ElementTypes.ElementType
   ducpy.utils.ElementTypes.Point
   ducpy.utils.ElementTypes.TilingProperties
   ducpy.utils.ElementTypes.ElementContentBase
   ducpy.utils.ElementTypes.StrokeStyleProps
   ducpy.utils.ElementTypes.ElementStroke
   ducpy.utils.ElementTypes.ElementBackground
   ducpy.utils.ElementTypes.BezierHandle
   ducpy.utils.ElementTypes.SimplePoint
   ducpy.utils.ElementTypes.ImageCrop
   ducpy.utils.ElementTypes.StrokeSides
   ducpy.utils.ElementTypes.BindingPoint
   ducpy.utils.ElementTypes.PointBinding
   ducpy.utils.ElementTypes.BoundElement
   ducpy.utils.ElementTypes.DucLineReference
   ducpy.utils.ElementTypes.DucLine
   ducpy.utils.ElementTypes.DucPath
   ducpy.utils.ElementTypes.DucTableStyleProps
   ducpy.utils.ElementTypes.DucTableColumn
   ducpy.utils.ElementTypes.DucTableRow
   ducpy.utils.ElementTypes.DucTableCell
   ducpy.utils.ElementTypes.DucTableStyle


Module Contents
---------------

.. py:class:: ElementType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Create a collection of name/value pairs.

   Example enumeration:

   >>> class Color(Enum):
   ...     RED = 1
   ...     BLUE = 2
   ...     GREEN = 3

   Access them by:

   - attribute access:

     >>> Color.RED
     <Color.RED: 1>

   - value lookup:

     >>> Color(1)
     <Color.RED: 1>

   - name lookup:

     >>> Color['RED']
     <Color.RED: 1>

   Enumerations can be iterated over, and know how many members they have:

   >>> len(Color)
   3

   >>> list(Color)
   [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

   Methods can be added to enumerations, and members can have their own
   attributes -- see the documentation for details.


   .. py:attribute:: RECTANGLE
      :value: 'rectangle'



   .. py:attribute:: ELLIPSE
      :value: 'ellipse'



   .. py:attribute:: FREEDRAW
      :value: 'freedraw'



   .. py:attribute:: LINE
      :value: 'line'



   .. py:attribute:: ARROW
      :value: 'arrow'



   .. py:attribute:: IMAGE
      :value: 'image'



   .. py:attribute:: TEXT
      :value: 'text'



   .. py:attribute:: TABLE
      :value: 'table'



   .. py:attribute:: FRAME
      :value: 'frame'



   .. py:attribute:: GROUP
      :value: 'group'



   .. py:attribute:: MAGIC_FRAME
      :value: 'magicframe'



   .. py:attribute:: DOC
      :value: 'doc'



   .. py:attribute:: POLYGON
      :value: 'polygon'



.. py:class:: Point

   .. py:attribute:: x
      :type:  float


   .. py:attribute:: y
      :type:  float


   .. py:attribute:: mirroring
      :type:  Optional[ducpy.utils.enums.BezierMirroring]
      :value: None



.. py:class:: TilingProperties

   .. py:attribute:: scale
      :type:  float


   .. py:attribute:: offset_x
      :type:  float


   .. py:attribute:: offset_y
      :type:  float


   .. py:attribute:: rotation
      :type:  float


.. py:class:: ElementContentBase

   .. py:attribute:: preference
      :type:  int


   .. py:attribute:: src
      :type:  str


   .. py:attribute:: visible
      :type:  bool


   .. py:attribute:: opacity
      :type:  float


   .. py:attribute:: tiling
      :type:  Optional[TilingProperties]
      :value: None



.. py:class:: StrokeStyleProps

   .. py:attribute:: preference
      :type:  int


   .. py:attribute:: cap
      :type:  Optional[ducpy.utils.enums.StrokeCap]
      :value: None



   .. py:attribute:: join
      :type:  Optional[int]
      :value: None



   .. py:attribute:: dash
      :type:  Optional[List[float]]
      :value: None



   .. py:attribute:: dash_cap
      :type:  Optional[ducpy.utils.enums.StrokeCap]
      :value: None



   .. py:attribute:: miter_limit
      :type:  Optional[float]
      :value: None



.. py:class:: ElementStroke

   .. py:attribute:: content
      :type:  ElementContentBase


   .. py:attribute:: width
      :type:  float


   .. py:attribute:: style
      :type:  StrokeStyleProps


   .. py:attribute:: placement
      :type:  int


   .. py:attribute:: stroke_sides
      :type:  Optional[StrokeSides]
      :value: None



.. py:class:: ElementBackground

   .. py:attribute:: content
      :type:  ElementContentBase


.. py:class:: BezierHandle

   .. py:attribute:: x
      :type:  float


   .. py:attribute:: y
      :type:  float


.. py:class:: SimplePoint

   .. py:attribute:: x
      :type:  float


   .. py:attribute:: y
      :type:  float


.. py:class:: ImageCrop

   .. py:attribute:: top
      :type:  float


   .. py:attribute:: right
      :type:  float


   .. py:attribute:: bottom
      :type:  float


   .. py:attribute:: left
      :type:  float


.. py:class:: StrokeSides

   .. py:attribute:: preference
      :type:  int


   .. py:attribute:: values
      :type:  Optional[List[float]]
      :value: None



.. py:class:: BindingPoint

   .. py:attribute:: index
      :type:  int


   .. py:attribute:: offset
      :type:  float


.. py:class:: PointBinding

   .. py:attribute:: element_id
      :type:  str


   .. py:attribute:: focus
      :type:  float


   .. py:attribute:: gap
      :type:  float


   .. py:attribute:: point
      :type:  Optional[BindingPoint]
      :value: None



   .. py:attribute:: head
      :type:  Optional[int]
      :value: None



   .. py:attribute:: fixed_point
      :type:  Optional[SimplePoint]
      :value: None



.. py:class:: BoundElement

   .. py:attribute:: id
      :type:  str


   .. py:attribute:: type
      :type:  str


.. py:class:: DucLineReference

   .. py:attribute:: index
      :type:  int


   .. py:attribute:: handle
      :type:  Optional[SimplePoint]
      :value: None



.. py:class:: DucLine

   .. py:attribute:: start
      :type:  DucLineReference


   .. py:attribute:: end
      :type:  DucLineReference


.. py:class:: DucPath

   .. py:attribute:: line_indices
      :type:  List[int]


   .. py:attribute:: background
      :type:  ElementBackground


   .. py:attribute:: stroke
      :type:  ElementStroke


.. py:class:: DucTableStyleProps

   .. py:attribute:: background_color
      :type:  Optional[str]
      :value: None



   .. py:attribute:: border_width
      :type:  Optional[float]
      :value: None



   .. py:attribute:: border_dashes
      :type:  List[float]
      :value: []



   .. py:attribute:: border_color
      :type:  Optional[str]
      :value: None



   .. py:attribute:: text_color
      :type:  Optional[str]
      :value: None



   .. py:attribute:: text_size
      :type:  Optional[float]
      :value: None



   .. py:attribute:: text_font
      :type:  Optional[str]
      :value: None



   .. py:attribute:: text_align
      :type:  Optional[int]
      :value: None



.. py:class:: DucTableColumn

   .. py:attribute:: id
      :type:  str


   .. py:attribute:: width
      :type:  float


   .. py:attribute:: style
      :type:  Optional[DucTableStyleProps]
      :value: None



.. py:class:: DucTableRow

   .. py:attribute:: id
      :type:  str


   .. py:attribute:: height
      :type:  float


   .. py:attribute:: style
      :type:  Optional[DucTableStyleProps]
      :value: None



.. py:class:: DucTableCell

   .. py:attribute:: row_id
      :type:  str


   .. py:attribute:: column_id
      :type:  str


   .. py:attribute:: data
      :type:  Optional[str]
      :value: None



   .. py:attribute:: style
      :type:  Optional[DucTableStyleProps]
      :value: None



.. py:class:: DucTableStyle

   .. py:attribute:: default_props
      :type:  Optional[DucTableStyleProps]
      :value: None



.. py:data:: StrokeStyle