ducpy.classes.ElementsClass¶

Attributes¶

Classes¶

`DictionaryEntry`
`StringValueEntry`
`GeometricPoint`
`DucPoint`
`Margins`
`Viewer3DClipPlane`
`Viewer3DMaterial`
`Viewer3DZebra`
`Viewer3DCamera`
`Viewer3DGridPlanes`
`Viewer3DGrid`	Tagged union: {"type": "uniform", "value": bool} or {"type": "perPlane", "value": Viewer3DGridPlanes}
`Viewer3DDisplay`
`Viewer3DClipping`
`Viewer3DExplode`
`Viewer3DState`
`TilingProperties`
`HatchPatternLine`
`CustomHatchPattern`
`DucHatchStyle`
`DucImageFilter`
`ElementContentBase`
`StrokeStyle`
`StrokeSides`
`ElementStroke`
`ElementBackground`
`DucElementStylesBase`
`BoundElement`
`DucElementBase`
`DucHead`
`PointBindingPoint`
`DucPointBinding`
`DucLineReference`
`DucLine`
`DucPath`
`DucLinearElementBase`
`DucStackLikeStyles`
`DucStackBase`
`DucStackElementBase`
`LineSpacing`
`DucTextStyle`
`DucTableStyle`
`DucDocStyle`
`DucPlotStyle`
`DucRectangleElement`
`DucPolygonElement`
`DucEllipseElement`
`DucEmbeddableElement`
`DocumentGridConfig`
`DucPdfElement`
`DucDocElement`
`DucTableElement`
`ImageCrop`
`DucImageElement`
`DucTextElement`
`DucLinearElement`
`DucArrowElement`
`DucFreeDrawEnds`
`DucFreeDrawElement`
`DucFrameElement`
`PlotLayout`
`DucPlotElement`
`DucModelElement`
`DucBlockDuplicationArray`
`DucBlockMetadata`
`DucBlock`
`DucBlockInstance`
`DucBlockCollectionEntry`
`DucBlockCollection`
`DucGroup`
`DucRegion`
`DucLayerOverrides`
`DucLayer`
`ElementWrapper`

Module Contents¶

class ducpy.classes.ElementsClass.DictionaryEntry¶

key: str¶

value: str¶

class ducpy.classes.ElementsClass.StringValueEntry¶

key: str¶

value: str¶

class ducpy.classes.ElementsClass.GeometricPoint¶

x: float¶

y: float¶

class ducpy.classes.ElementsClass.DucPoint¶

x: float¶

y: float¶

mirroring: ducpy.enums.BEZIER_MIRRORING | None = None¶

class ducpy.classes.ElementsClass.Margins¶

top: float¶

right: float¶

bottom: float¶

left: float¶

class ducpy.classes.ElementsClass.Viewer3DClipPlane¶

enabled: bool¶

value: float¶

normal: List[float] | None = None¶

class ducpy.classes.ElementsClass.Viewer3DMaterial¶

metalness: float¶

roughness: float¶

default_opacity: float¶

edge_color: int¶

ambient_intensity: float¶

direct_intensity: float¶

class ducpy.classes.ElementsClass.Viewer3DZebra¶

active: bool¶

stripe_count: int¶

stripe_direction: float¶

color_scheme: str¶

opacity: float¶

mapping_mode: str¶

class ducpy.classes.ElementsClass.Viewer3DCamera¶

control: str¶

ortho: bool¶

up: str¶

position: List[float]¶

quaternion: List[float]¶

target: List[float]¶

zoom: float¶

pan_speed: float¶

rotate_speed: float¶

zoom_speed: float¶

holroyd: bool¶

class ducpy.classes.ElementsClass.Viewer3DGridPlanes¶

xy: bool¶

xz: bool¶

yz: bool¶

class ducpy.classes.ElementsClass.Viewer3DGrid¶

Tagged union: {“type”: “uniform”, “value”: bool} or {“type”: “perPlane”, “value”: Viewer3DGridPlanes}

type: str¶

value: Any¶

class ducpy.classes.ElementsClass.Viewer3DDisplay¶

wireframe: bool¶

transparent: bool¶

black_edges: bool¶

grid: Viewer3DGrid¶

axes_visible: bool¶

axes_at_origin: bool¶

class ducpy.classes.ElementsClass.Viewer3DClipping¶

x: Viewer3DClipPlane¶

y: Viewer3DClipPlane¶

z: Viewer3DClipPlane¶

intersection: bool¶

show_planes: bool¶

object_color_caps: bool¶

class ducpy.classes.ElementsClass.Viewer3DExplode¶

active: bool¶

value: float¶

class ducpy.classes.ElementsClass.Viewer3DState¶

camera: Viewer3DCamera¶

display: Viewer3DDisplay¶

material: Viewer3DMaterial¶

clipping: Viewer3DClipping¶

explode: Viewer3DExplode¶

zebra: Viewer3DZebra¶

class ducpy.classes.ElementsClass.TilingProperties¶

size_in_percent: float¶

angle: float¶

spacing: float | None = None¶

offset_x: float | None = None¶

offset_y: float | None = None¶

class ducpy.classes.ElementsClass.HatchPatternLine¶

angle: float¶

origin: DucPoint¶

offset: List[float]¶

dash_pattern: List[float]¶

class ducpy.classes.ElementsClass.CustomHatchPattern¶

name: str¶

lines: List[HatchPatternLine]¶

description: str | None = None¶

class ducpy.classes.ElementsClass.DucHatchStyle¶

hatch_style: ducpy.enums.HATCH_STYLE¶

pattern_name: str¶

pattern_scale: float¶

pattern_angle: float¶

pattern_origin: DucPoint¶

pattern_double: bool¶

custom_pattern: CustomHatchPattern | None = None¶

class ducpy.classes.ElementsClass.DucImageFilter¶

brightness: float¶

contrast: float¶

class ducpy.classes.ElementsClass.ElementContentBase¶

src: str¶

visible: bool¶

opacity: float¶

preference: ducpy.enums.ELEMENT_CONTENT_PREFERENCE | None = None¶

tiling: TilingProperties | None = None¶

hatch: DucHatchStyle | None = None¶

image_filter: DucImageFilter | None = None¶

class ducpy.classes.ElementsClass.StrokeStyle¶

preference: ducpy.enums.STROKE_PREFERENCE | None = None¶

cap: ducpy.enums.STROKE_CAP | None = None¶

join: ducpy.enums.STROKE_JOIN | None = None¶

dash: List[float] | None = None¶

dash_line_override: str | None = None¶

dash_cap: ducpy.enums.STROKE_CAP | None = None¶

miter_limit: float | None = None¶

class ducpy.classes.ElementsClass.StrokeSides¶

preference: ducpy.enums.STROKE_SIDE_PREFERENCE | None = None¶

values: List[float] | None = None¶

class ducpy.classes.ElementsClass.ElementStroke¶

content: ElementContentBase¶

width: float¶

style: StrokeStyle¶

placement: ducpy.enums.STROKE_PLACEMENT | None = None¶

stroke_sides: StrokeSides | None = None¶

class ducpy.classes.ElementsClass.ElementBackground¶

content: ElementContentBase¶

class ducpy.classes.ElementsClass.DucElementStylesBase¶

roundness: float¶

background: List[ElementBackground]¶

stroke: List[ElementStroke]¶

opacity: float¶

blending: ducpy.enums.BLENDING | None = None¶

class ducpy.classes.ElementsClass.BoundElement¶

id: str¶

type: str¶

class ducpy.classes.ElementsClass.DucElementBase¶

id: str¶

styles: DucElementStylesBase¶

x: float¶

y: float¶

width: float¶

height: float¶

angle: float¶

scope: str¶

label: str¶

is_visible: bool¶

seed: int¶

version: int¶

version_nonce: int¶

updated: int¶

is_plot: bool¶

is_deleted: bool¶

group_ids: List[str]¶

block_ids: List[str]¶

region_ids: List[str]¶

z_index: float¶

locked: bool¶

description: str | None = None¶

index: str | None = None¶

instance_id: str | None = None¶

layer_id: str | None = None¶

frame_id: str | None = None¶

bound_elements: List[BoundElement] | None = None¶

link: str | None = None¶

custom_data: str | None = None¶

class ducpy.classes.ElementsClass.DucHead¶

size: float¶

type: ducpy.enums.LINE_HEAD | None = None¶

block_id: str | None = None¶

class ducpy.classes.ElementsClass.PointBindingPoint¶

index: int¶

offset: float¶

class ducpy.classes.ElementsClass.DucPointBinding¶

element_id: str¶

focus: float¶

gap: float¶

fixed_point: GeometricPoint | None = None¶

point: PointBindingPoint | None = None¶

head: DucHead | None = None¶

class ducpy.classes.ElementsClass.DucLineReference¶

index: int¶

handle: GeometricPoint | None = None¶

class ducpy.classes.ElementsClass.DucLine¶

start: DucLineReference¶

end: DucLineReference¶

class ducpy.classes.ElementsClass.DucPath¶

line_indices: List[int]¶

background: ElementBackground | None = None¶

stroke: ElementStroke | None = None¶

class ducpy.classes.ElementsClass.DucLinearElementBase¶

base: DucElementBase¶

points: List[DucPoint]¶

lines: List[DucLine]¶

path_overrides: List[DucPath]¶

last_committed_point: DucPoint | None = None¶

start_binding: DucPointBinding | None = None¶

end_binding: DucPointBinding | None = None¶

class ducpy.classes.ElementsClass.DucStackLikeStyles¶

opacity: float¶

class ducpy.classes.ElementsClass.DucStackBase¶

label: str¶

is_collapsed: bool¶

is_plot: bool¶

is_visible: bool¶

locked: bool¶

styles: DucStackLikeStyles¶

description: str | None = None¶

class ducpy.classes.ElementsClass.DucStackElementBase¶

base: DucElementBase¶

stack_base: DucStackBase¶

clip: bool¶

label_visible: bool¶

class ducpy.classes.ElementsClass.LineSpacing¶

value: float¶

type: ducpy.enums.LINE_SPACING_TYPE | None = None¶

class ducpy.classes.ElementsClass.DucTextStyle¶

is_ltr: bool¶

font_family: str¶

big_font_family: str¶

text_align: ducpy.enums.TEXT_ALIGN¶

vertical_align: ducpy.enums.VERTICAL_ALIGN¶

line_height: float¶

line_spacing: LineSpacing¶

oblique_angle: float¶

font_size: float¶

width_factor: float¶

is_upside_down: bool¶

is_backwards: bool¶

class ducpy.classes.ElementsClass.DucTableStyle¶

class ducpy.classes.ElementsClass.DucDocStyle¶

class ducpy.classes.ElementsClass.DucPlotStyle¶

class ducpy.classes.ElementsClass.DucRectangleElement¶

base: DucElementBase¶

class ducpy.classes.ElementsClass.DucPolygonElement¶

base: DucElementBase¶

sides: int¶

class ducpy.classes.ElementsClass.DucEllipseElement¶

base: DucElementBase¶

ratio: float¶

start_angle: float¶

end_angle: float¶

show_aux_crosshair: bool¶

class ducpy.classes.ElementsClass.DucEmbeddableElement¶

base: DucElementBase¶

class ducpy.classes.ElementsClass.DocumentGridConfig¶

columns: int¶

gap_x: float¶

gap_y: float¶

first_page_alone: bool¶

scale: float¶

class ducpy.classes.ElementsClass.DucPdfElement¶

base: DucElementBase¶

grid_config: DocumentGridConfig¶

file_id: str | None = None¶

class ducpy.classes.ElementsClass.DucDocElement¶

base: DucElementBase¶

style: DucDocStyle¶

text: str¶

grid_config: DocumentGridConfig¶

file_id: str | None = None¶

class ducpy.classes.ElementsClass.DucTableElement¶

base: DucElementBase¶

style: DucTableStyle¶

file_id: str | None = None¶

class ducpy.classes.ElementsClass.ImageCrop¶

x: float¶

y: float¶

width: float¶

height: float¶

natural_width: float¶

natural_height: float¶

class ducpy.classes.ElementsClass.DucImageElement¶

base: DucElementBase¶

status: ducpy.enums.IMAGE_STATUS¶

scale: List[float]¶

file_id: str | None = None¶

crop: ImageCrop | None = None¶

filter: DucImageFilter | None = None¶

class ducpy.classes.ElementsClass.DucTextElement¶

base: DucElementBase¶

style: DucTextStyle¶

text: str¶

auto_resize: bool¶

original_text: str¶

container_id: str | None = None¶

class ducpy.classes.ElementsClass.DucLinearElement¶

linear_base: DucLinearElementBase¶

wipeout_below: bool¶

class ducpy.classes.ElementsClass.DucArrowElement¶

linear_base: DucLinearElementBase¶

elbowed: bool¶

class ducpy.classes.ElementsClass.DucFreeDrawEnds¶

cap: bool¶

taper: float¶

easing: str¶

class ducpy.classes.ElementsClass.DucFreeDrawElement¶

base: DucElementBase¶

points: List[DucPoint]¶

size: float¶

thinning: float¶

smoothing: float¶

streamline: float¶

easing: str¶

pressures: List[float]¶

simulate_pressure: bool¶

start: DucFreeDrawEnds | None = None¶

end: DucFreeDrawEnds | None = None¶

last_committed_point: DucPoint | None = None¶

svg_path: str | None = None¶

class ducpy.classes.ElementsClass.DucFrameElement¶

stack_element_base: DucStackElementBase¶

class ducpy.classes.ElementsClass.PlotLayout¶

margins: Margins¶

class ducpy.classes.ElementsClass.DucPlotElement¶

stack_element_base: DucStackElementBase¶

style: DucPlotStyle¶

layout: PlotLayout¶

class ducpy.classes.ElementsClass.DucModelElement¶

base: DucElementBase¶

file_ids: List[str]¶

model_type: str | None = None¶

code: str | None = None¶

svg_path: str | None = None¶

viewer_state: Viewer3DState | None = None¶

class ducpy.classes.ElementsClass.DucBlockDuplicationArray¶

rows: int¶

cols: int¶

row_spacing: float¶

col_spacing: float¶

class ducpy.classes.ElementsClass.DucBlockMetadata¶

usage_count: int¶

created_at: int¶

updated_at: int¶

source: str | None = None¶

localization: str | None = None¶

class ducpy.classes.ElementsClass.DucBlock¶

id: str¶

label: str¶

version: int¶

description: str | None = None¶

metadata: DucBlockMetadata | None = None¶

thumbnail: bytes | None = None¶

class ducpy.classes.ElementsClass.DucBlockInstance¶

id: str¶

block_id: str¶

version: int¶

element_overrides: List[StringValueEntry] | None = None¶

duplication_array: DucBlockDuplicationArray | None = None¶

class ducpy.classes.ElementsClass.DucBlockCollectionEntry¶

id: str¶

is_collection: bool¶

class ducpy.classes.ElementsClass.DucBlockCollection¶

id: str¶

label: str¶

children: List[DucBlockCollectionEntry]¶

metadata: DucBlockMetadata | None = None¶

thumbnail: bytes | None = None¶

class ducpy.classes.ElementsClass.DucGroup¶

id: str¶

stack_base: DucStackBase¶

class ducpy.classes.ElementsClass.DucRegion¶

id: str¶

stack_base: DucStackBase¶

boolean_operation: ducpy.enums.BOOLEAN_OPERATION¶

class ducpy.classes.ElementsClass.DucLayerOverrides¶

stroke: ElementStroke¶

background: ElementBackground¶

class ducpy.classes.ElementsClass.DucLayer¶

id: str¶

stack_base: DucStackBase¶

readonly: bool¶

overrides: DucLayerOverrides | None = None¶

ducpy.classes.ElementsClass.DucElement¶

class ducpy.classes.ElementsClass.ElementWrapper¶

element: DucElement¶