ducpy.classes.DucElementClass ============================= .. py:module:: ducpy.classes.DucElementClass Attributes ---------- .. autoapisummary:: ducpy.classes.DucElementClass.DucElementUnion ducpy.classes.DucElementClass.DucElement Classes ------- .. autoapisummary:: ducpy.classes.DucElementClass.SimplePoint ducpy.classes.DucElementClass.Point ducpy.classes.DucElementClass.BezierHandle ducpy.classes.DucElementClass.TilingProperties ducpy.classes.DucElementClass.ElementContentBase ducpy.classes.DucElementClass.StrokeStyleProps ducpy.classes.DucElementClass.StrokeSides ducpy.classes.DucElementClass.ElementStroke ducpy.classes.DucElementClass.ElementBackground ducpy.classes.DucElementClass.ImageCrop ducpy.classes.DucElementClass.BindingPoint ducpy.classes.DucElementClass.PointBinding ducpy.classes.DucElementClass.BoundElement ducpy.classes.DucElementClass.DucLineReference ducpy.classes.DucElementClass.DucLine ducpy.classes.DucElementClass.DucPath ducpy.classes.DucElementClass.DucTableStyleProps ducpy.classes.DucElementClass.DucTableColumn ducpy.classes.DucElementClass.DucTableRow ducpy.classes.DucElementClass.DucTableCell ducpy.classes.DucElementClass.DucTableStyle ducpy.classes.DucElementClass.DucElementBase ducpy.classes.DucElementClass.DucSelectionElement ducpy.classes.DucElementClass.DucRectangleElement ducpy.classes.DucElementClass.DucPolygonElement ducpy.classes.DucElementClass.DucEllipseElement ducpy.classes.DucElementClass.DucImageElement ducpy.classes.DucElementClass.DucGroupingElementBase ducpy.classes.DucElementClass.DucFrameElement ducpy.classes.DucElementClass.DucGroupElement ducpy.classes.DucElementClass.DucMagicFrameElement ducpy.classes.DucElementClass.DucEmbeddableElement ducpy.classes.DucElementClass.DucIframeElement ducpy.classes.DucElementClass.DucTableElement ducpy.classes.DucElementClass.DucDocElement ducpy.classes.DucElementClass.DucTextElement ducpy.classes.DucElementClass.DucLinearElement ducpy.classes.DucElementClass.DucArrowElement ducpy.classes.DucElementClass.DucFreeDrawEnds ducpy.classes.DucElementClass.DucFreeDrawElement Module Contents --------------- .. py:class:: SimplePoint .. py:attribute:: x :type: float .. py:attribute:: y :type: float .. 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:: BezierHandle .. py:attribute:: x :type: float .. py:attribute:: y :type: float .. py:class:: TilingProperties .. py:attribute:: size_in_percent :type: float .. py:attribute:: angle :type: float .. py:attribute:: spacing :type: Optional[float] :value: None .. py:attribute:: offset_x :type: Optional[float] :value: None .. py:attribute:: offset_y :type: Optional[float] :value: None .. 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:: StrokeSides .. py:attribute:: preference :type: int .. py:attribute:: values :type: Optional[List[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:: ImageCrop .. py:attribute:: x :type: float .. py:attribute:: y :type: float .. py:attribute:: width :type: float .. py:attribute:: height :type: float .. py:attribute:: natural_width :type: float .. py:attribute:: natural_height :type: float .. 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: Optional[ElementBackground] :value: None .. py:attribute:: stroke :type: Optional[ElementStroke] :value: None .. 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: Optional[float] :value: None .. py:attribute:: style :type: Optional[DucTableStyleProps] :value: None .. py:class:: DucTableRow .. py:attribute:: id :type: str .. py:attribute:: height :type: Optional[float] :value: None .. 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:class:: DucElementBase .. py:attribute:: id :type: str .. py:attribute:: type :type: str .. py:attribute:: x :type: float .. py:attribute:: y :type: float .. py:attribute:: scope :type: str .. py:attribute:: subset :type: Optional[ducpy.utils.enums.ElementSubset] :value: None .. py:attribute:: label :type: str :value: '' .. py:attribute:: is_visible :type: bool :value: True .. py:attribute:: roundness :type: float :value: 0.0 .. py:attribute:: blending :type: Optional[int] :value: None .. py:attribute:: stroke_color :type: Optional[str] :value: None .. py:attribute:: background_color :type: Optional[str] :value: None .. py:attribute:: background :type: List[ElementBackground] :value: [] .. py:attribute:: stroke :type: List[ElementStroke] :value: [] .. py:attribute:: opacity :type: float :value: 1.0 .. py:attribute:: width :type: float :value: 0.0 .. py:attribute:: height :type: float :value: 0.0 .. py:attribute:: angle :type: float :value: 0.0 .. py:attribute:: seed :type: int :value: 0 .. py:attribute:: version :type: int :value: 1 .. py:attribute:: version_nonce :type: int :value: 0 .. py:attribute:: is_deleted :type: bool :value: False .. py:attribute:: group_ids :type: List[str] :value: [] .. py:attribute:: frame_id :type: Optional[str] :value: None .. py:attribute:: bound_elements :type: List[BoundElement] :value: [] .. py:attribute:: z_index :type: int :value: 0 .. py:attribute:: updated :type: int :value: 0 .. py:attribute:: index :type: Optional[str] :value: None .. py:attribute:: link :type: Optional[str] :value: None .. py:attribute:: locked :type: bool :value: False .. py:attribute:: custom_data :type: Optional[Dict[str, Any]] :value: None .. py:class:: DucSelectionElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'selection' .. py:class:: DucRectangleElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'rectangle' .. py:class:: DucPolygonElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'polygon' .. py:attribute:: sides :type: int :value: 6 .. py:class:: DucEllipseElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'ellipse' .. py:attribute:: ratio :type: float :value: 1.0 .. py:attribute:: start_angle :type: float :value: 0.0 .. py:attribute:: end_angle :type: float :value: 360.0 .. py:attribute:: show_aux_crosshair :type: bool :value: False .. py:class:: DucImageElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'image' .. py:attribute:: file_id :type: Optional[str] :value: None .. py:attribute:: status :type: Optional[str] :value: None .. py:attribute:: scale :type: List[float] :value: [1.0, 1.0] .. py:attribute:: crop :type: Optional[ImageCrop] :value: None .. py:class:: DucGroupingElementBase Bases: :py:obj:`DucElementBase` .. py:attribute:: is_collapsed :type: bool :value: False .. py:attribute:: clip :type: bool :value: False .. py:class:: DucFrameElement Bases: :py:obj:`DucGroupingElementBase` .. py:attribute:: type :type: str :value: 'frame' .. py:class:: DucGroupElement Bases: :py:obj:`DucGroupingElementBase` .. py:attribute:: type :type: str :value: 'group' .. py:attribute:: group_id_ref :type: str :value: '' .. py:class:: DucMagicFrameElement Bases: :py:obj:`DucGroupingElementBase` .. py:attribute:: type :type: str :value: 'magicframe' .. py:class:: DucEmbeddableElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'embeddable' .. py:class:: DucIframeElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'iframe' .. py:class:: DucTableElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'table' .. py:attribute:: column_order :type: List[str] :value: [] .. py:attribute:: row_order :type: List[str] :value: [] .. py:attribute:: columns :type: List[DucTableColumn] :value: [] .. py:attribute:: rows :type: List[DucTableRow] :value: [] .. py:attribute:: cells :type: List[DucTableCell] :value: [] .. py:attribute:: style :type: Optional[DucTableStyleProps] :value: None .. py:class:: DucDocElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'doc' .. py:attribute:: content :type: str :value: '' .. py:class:: DucTextElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'text' .. py:attribute:: font_size :type: float :value: 14.0 .. py:attribute:: font_family :type: Optional[str] :value: None .. py:attribute:: text :type: str :value: '' .. py:attribute:: text_align :type: Optional[str] :value: None .. py:attribute:: vertical_align :type: Optional[str] :value: None .. py:attribute:: container_id :type: Optional[str] :value: None .. py:attribute:: original_text :type: Optional[str] :value: None .. py:attribute:: auto_resize :type: bool :value: True .. py:attribute:: line_height :type: float :value: 1.2 .. py:class:: DucLinearElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'line' .. py:attribute:: points :type: List[Point] :value: [] .. py:attribute:: lines :type: List[DucLine] :value: [] .. py:attribute:: path_overrides :type: List[DucPath] :value: [] .. py:attribute:: last_committed_point :type: Optional[Point] :value: None .. py:attribute:: start_binding :type: Optional[PointBinding] :value: None .. py:attribute:: end_binding :type: Optional[PointBinding] :value: None .. py:class:: DucArrowElement Bases: :py:obj:`DucLinearElement` .. py:attribute:: type :type: str :value: 'arrow' .. py:attribute:: elbowed :type: bool :value: False .. py:class:: DucFreeDrawEnds .. py:attribute:: cap :type: bool .. py:attribute:: taper :type: float .. py:attribute:: easing :type: str .. py:class:: DucFreeDrawElement Bases: :py:obj:`DucElementBase` .. py:attribute:: type :type: str :value: 'freedraw' .. py:attribute:: points :type: List[Point] :value: [] .. py:attribute:: size :type: float :value: 1.0 .. py:attribute:: thinning :type: float :value: 0.0 .. py:attribute:: smoothing :type: float :value: 0.0 .. py:attribute:: streamline :type: float :value: 0.0 .. py:attribute:: easing :type: str :value: 'linear' .. py:attribute:: start :type: Optional[DucFreeDrawEnds] :value: None .. py:attribute:: end :type: Optional[DucFreeDrawEnds] :value: None .. py:attribute:: pressures :type: List[float] :value: [] .. py:attribute:: simulate_pressure :type: bool :value: False .. py:attribute:: last_committed_point :type: Optional[Point] :value: None .. py:attribute:: svg_path :type: Optional[str] :value: None .. py:data:: DucElementUnion .. py:data:: DucElement