Shapes

Drawing classes ShapeBase, LineShape, PolylineShape, PolygonShape, RectangleShape, EllipseShape, ConnectorShape and DrawGroup.

Classes:

Name	Description
AngleMix	Kind, start_angle and end_angle for circle and ellipse.
CircleShape	Represents an circular shape, “draw:circle”.
ConnectorShape	Represents a connector shape, “draw:connector”.
DrawCaption	Represents a description attached to a fixed point, “draw:caption”.
DrawControl	Represents a shape that is linked to a control inside an
DrawGroup	Representation of a group of drawing shapes, “draw:g”.
DrawMeasure	Represents a shape that is used to measure distances in drawings,
DrawPageThumbnail	Represents a rectangular area that displays the thumbnail of a
DrawPath	Represents a path, “draw:path”.
EllipseShape	Represents an ellipse shape, “draw:ellipse”.
LineShape	Represents a line shape, “draw:line”.
PolygonShape	Represents a polygon, “draw:polygon”.
PolylineShape	Represents a polyline shape, “draw:polyline”.
RectangleShape	Represents a rectangle shape, “draw:rect”.
RegularPolygonShape	Represents a regular polygon, “draw:regular-polygon”.
ShapeBase	Base class for all drawing shapes.

Attributes:

Name	Type	Description
registered_shapes

registered_shapes module-attribute

registered_shapes = [
    (_tag)
    for s in (
        CircleShape,
        ConnectorShape,
        DrawCaption,
        DrawControl,
        DrawMeasure,
        DrawPageThumbnail,
        DrawPath,
        EllipseShape,
        LineShape,
        PolygonShape,
        PolylineShape,
        RectangleShape,
        RegularPolygonShape,
    )
]

AngleMix

Bases: Element

Kind, start_angle and end_angle for circle and ellipse.

Kind value can be: ‘full’, ‘section’, ‘cut’ or ‘arc’. Default is ‘full’.

Attributes:

Name	Type	Description
KIND_VALUE_CHOICE
kind	str	Get or set the kind, “draw:kind”.

Source code in odfdo/shapes.py

class AngleMix(Element):
    """Kind, start_angle and end_angle for circle and ellipse.

    Kind value can be: 'full', 'section', 'cut' or 'arc'. Default is 'full'.
    """

    _tag = "draw:anglemix-odfdo-notodf"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("start_angle", "draw:start-angle"),
        PropDef("end_angle", "draw:end-angle"),
    )

    KIND_VALUE_CHOICE = {  # noqa: RUF012
        "full",
        "section",
        "cut",
        "arc",
    }

    @property
    def kind(self) -> str:
        'Get or set the kind, "draw:kind".'
        return self._get_attribute_str_default("draw:kind", "full")

    @kind.setter
    def kind(self, kind: str) -> None:
        if kind not in self.KIND_VALUE_CHOICE:
            raise TypeError(f"'draw:kind' not valid: {kind!r}")
        self._set_attribute_str_default("draw:kind", kind, "full")

KIND_VALUE_CHOICE class-attribute instance-attribute

KIND_VALUE_CHOICE = {'full', 'section', 'cut', 'arc'}

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("start_angle", "draw:start-angle"),
    PropDef("end_angle", "draw:end-angle"),
)

_tag class-attribute instance-attribute

_tag = 'draw:anglemix-odfdo-notodf'

kind property writable

kind: str

Get or set the kind, “draw:kind”.

CircleShape

Bases: AngleMix, PosMix, SizeMix, ShapeBase

Represents an circular shape, “draw:circle”.

This shape defines a circular area.

Methods:

Name	Description
__init__	Create a circular shape “draw:circle”.

Attributes:

Name	Type	Description
center	tuple[str | None, str | None]	Get or set the center (cx, cy) coordinates of the circle.
end_angle
kind
position
radius
size
start_angle

Source code in odfdo/shapes.py

class CircleShape(AngleMix, PosMix, SizeMix, ShapeBase):
    """Represents an circular shape, "draw:circle".

    This shape defines a circular area.
    """

    _tag = "draw:circle"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("radius", "svg:r"),
        PropDef("cx", "svg:cx"),
        PropDef("cy", "svg:cy"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        radius: str | None = None,
        kind: str | None = None,
        start_angle: str | None = None,
        end_angle: str | None = None,
        center: tuple[str, str] | list[str] | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a circular shape "draw:circle".

        Args:
            name: Name of the graphical element.
            style: The style name for the circle.
            text_style: The text style name for the circle.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the circle.
            position: The (x, y) coordinates for the circle's position.
            size: The (width, height) for the circle's size.
            radius: The radius of the circle.
            kind: The appearance of a circle or circle, "full", "section",
                "cut" or "arc". Default is "full".
            start_angle: The start angle of a section, cut, or arc where the
                draw:kind is "section", "cut" or "arc".
            end_angle: The end angle of a section, cut, or arc where the
                draw:kind is "section", "cut" or "arc".
            center: The x-axis coordinate of the center of a circular image map
                area.
            center: The (cx, cy) coordinates of the center of the circle.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if position:
                self.position = position
            if size:
                self.size = size
            if radius:
                self.radius = radius
            if kind:
                self.kind = kind
            if start_angle:
                self.start_angle = start_angle
            if end_angle:
                self.end_angle = end_angle
            if center:
                self.center = center

    @property
    def center(self) -> tuple[str | None, str | None]:
        "Get or set the center (cx, cy) coordinates of the circle."
        return (self.cx, self.cy)

    @center.setter
    def center(self, center: tuple[str, str] | list[str] | None) -> None:
        if center is None:
            self.cx = None
            self.cy = None
        else:
            self.cx = center[0]
            self.cy = center[1]

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("radius", "svg:r"),
    PropDef("cx", "svg:cx"),
    PropDef("cy", "svg:cy"),
)

_tag class-attribute instance-attribute

_tag = 'draw:circle'

center property writable

center: tuple[str | None, str | None]

Get or set the center (cx, cy) coordinates of the circle.

end_angle instance-attribute

end_angle = end_angle

kind instance-attribute

kind = kind

position instance-attribute

position = position

radius instance-attribute

radius = radius

size instance-attribute

size = size

start_angle instance-attribute

start_angle = start_angle

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    radius: str | None = None,
    kind: str | None = None,
    start_angle: str | None = None,
    end_angle: str | None = None,
    center: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a circular shape “draw:circle”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the circle.	None
text_style	str | None	The text style name for the circle.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the circle.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the circle’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) for the circle’s size.	None
radius	str | None	The radius of the circle.	None
kind	str | None	The appearance of a circle or circle, “full”, “section”, “cut” or “arc”. Default is “full”.	None
start_angle	str | None	The start angle of a section, cut, or arc where the draw:kind is “section”, “cut” or “arc”.	None
end_angle	str | None	The end angle of a section, cut, or arc where the draw:kind is “section”, “cut” or “arc”.	None
center	tuple[str, str] | list[str] | None	The x-axis coordinate of the center of a circular image map area.	None
center	tuple[str, str] | list[str] | None	The (cx, cy) coordinates of the center of the circle.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    radius: str | None = None,
    kind: str | None = None,
    start_angle: str | None = None,
    end_angle: str | None = None,
    center: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a circular shape "draw:circle".

    Args:
        name: Name of the graphical element.
        style: The style name for the circle.
        text_style: The text style name for the circle.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the circle.
        position: The (x, y) coordinates for the circle's position.
        size: The (width, height) for the circle's size.
        radius: The radius of the circle.
        kind: The appearance of a circle or circle, "full", "section",
            "cut" or "arc". Default is "full".
        start_angle: The start angle of a section, cut, or arc where the
            draw:kind is "section", "cut" or "arc".
        end_angle: The end angle of a section, cut, or arc where the
            draw:kind is "section", "cut" or "arc".
        center: The x-axis coordinate of the center of a circular image map
            area.
        center: The (cx, cy) coordinates of the center of the circle.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if position:
            self.position = position
        if size:
            self.size = size
        if radius:
            self.radius = radius
        if kind:
            self.kind = kind
        if start_angle:
            self.start_angle = start_angle
        if end_angle:
            self.end_angle = end_angle
        if center:
            self.center = center

ConnectorShape

Bases: ShapeBase

Represents a connector shape, “draw:connector”.

A connector typically links two other shapes.

Methods:

Name	Description
__init__	Create a connector shape “draw:connector”.

Attributes:

Name	Type	Description
DRAW_TYOE_CHOICE
connected_shapes	tuple[str | None, str | None]	Get or set the connected shapes (“draw:start-shape”,
draw_type	str	Get or set the draw type, “draw:type”.
glue_points	tuple[str | None, str | None]	Get or set the the glue points for connection
line_skew
p1	tuple[str | None, str | None]	Get or set the (x1, y1) coordinates of the starting point.
p2	tuple[str | None, str | None]	Get or set the (x2, y2) coordinates of the ending point.
svg_d
view_box

Source code in odfdo/shapes.py

class ConnectorShape(ShapeBase):
    """Represents a connector shape, "draw:connector".

    A connector typically links two other shapes.
    """

    _tag = "draw:connector"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("start_shape", "draw:start-shape"),
        PropDef("end_shape", "draw:end-shape"),
        PropDef("start_glue_point", "draw:start-glue-point"),
        PropDef("end_glue_point", "draw:end-glue-point"),
        PropDef("x1", "svg:x1"),
        PropDef("y1", "svg:y1"),
        PropDef("x2", "svg:x2"),
        PropDef("y2", "svg:y2"),
        PropDef("line_skew", "draw:line-skew"),
        PropDef("svg_d", "svg:d"),
        PropDef("view_box", "svg:viewBox"),
    )

    DRAW_TYOE_CHOICE = {  # noqa: RUF012
        "standard",
        "lines",
        "line",
        "curve",
    }

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        connected_shapes: tuple[ShapeBase, ShapeBase] | list[ShapeBase] | None = None,
        glue_points: tuple[str | int, str | int] | list[str | int] | None = None,
        p1: tuple[str, str] | list[str] | None = None,
        p2: tuple[str, str] | list[str] | None = None,
        draw_type: str | None = None,
        line_skew: str | None = None,
        svg_d: str | None = None,
        view_box: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a connector shape "draw:connector".

        Args:
            name: Name of the graphical element.
            style: The style name for the connector.
            text_style: The text style name for the connector.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the connector.
            connected_shapes: A tuple of (start_shape, end_shape)
                where each shape is a shape with a `draw_id`.
            glue_points: A tuple of (start_glue_point, end_glue_point)
                specifying the glue points for connection.
            p1: The (x1, y1) coordinates of the starting point.
            p2: The (x2, y2) coordinates of the ending point.
            draw_type: The line or series of lines that connect two glue
                points. Values are 'standard' (default), 'lines', 'line'
                or 'curve'.
            line_skew: A list of offsets for the placements of connector
                lines if the connector is of type standard.
            svg_d: A path data.
            view_box: The rectangle in a local coordinates system used by the
                points.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if connected_shapes:
                self.connected_shapes = connected_shapes
            if glue_points:
                self.glue_points = glue_points
            self.p1 = p1
            self.p2 = p2
            if draw_type:
                self.draw_type = draw_type
            if line_skew:
                self.line_skew = line_skew
            if svg_d:
                self.svg_d = svg_d
            if view_box:
                self.view_box = view_box

    @property
    def connected_shapes(self) -> tuple[str | None, str | None]:
        """Get or set the connected shapes ("draw:start-shape",
        "draw:end-shape")."""
        get_attr = self.get_attribute_string
        return get_attr("draw:start-shape"), get_attr("draw:end-shape")

    @connected_shapes.setter
    def connected_shapes(
        self, connected_shapes: tuple[ShapeBase, ShapeBase] | list[ShapeBase] | None
    ) -> None:
        if connected_shapes is None:
            self.start_shape = None
            self.end_shape = None
        else:
            self.start_shape = connected_shapes[0].draw_id
            self.end_shape = connected_shapes[1].draw_id

    @property
    def glue_points(self) -> tuple[str | None, str | None]:
        """Get or set the the glue points for connection
        ("draw:start-glue-point", "draw:end-glue-point")."""
        get_attr = self.get_attribute_string
        return get_attr("draw:start-glue-point"), get_attr("draw:end-glue-point")

    @glue_points.setter
    def glue_points(
        self, glue_points: tuple[str | int, str | int] | list[str | int] | None
    ) -> None:
        if glue_points is None:
            self.start_glue_point = None
            self.end_glue_point = None
        else:
            self.start_glue_point = glue_points[0]
            self.end_glue_point = glue_points[1]

    @property
    def p1(self) -> tuple[str | None, str | None]:
        "Get or set the (x1, y1) coordinates of the starting point."
        return (self.x1, self.y1)

    @p1.setter
    def p1(self, p1: tuple[str, str] | list[str] | None) -> None:
        if p1 is None:
            self.x1 = None
            self.y1 = None
        else:
            self.x1 = p1[0]
            self.y1 = p1[1]

    @property
    def p2(self) -> tuple[str | None, str | None]:
        "Get or set the (x2, y2) coordinates of the ending point."
        return (self.x2, self.y2)

    @p2.setter
    def p2(self, p2: tuple[str, str] | list[str] | None) -> None:
        if p2 is None:
            self.x2 = None
            self.y2 = None
        else:
            self.x2 = p2[0]
            self.y2 = p2[1]

    @property
    def draw_type(self) -> str:
        'Get or set the draw type, "draw:type".'
        return self._get_attribute_str_default("draw:type", "standard")

    @draw_type.setter
    def draw_type(self, draw_type: str) -> None:
        if draw_type not in self.DRAW_TYOE_CHOICE:
            raise TypeError(f"'draw:type' not valid: {draw_type!r}")
        self._set_attribute_str_default("draw:type", draw_type, "standard")

DRAW_TYOE_CHOICE class-attribute instance-attribute

DRAW_TYOE_CHOICE = {'standard', 'lines', 'line', 'curve'}

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("start_shape", "draw:start-shape"),
    PropDef("end_shape", "draw:end-shape"),
    PropDef("start_glue_point", "draw:start-glue-point"),
    PropDef("end_glue_point", "draw:end-glue-point"),
    PropDef("x1", "svg:x1"),
    PropDef("y1", "svg:y1"),
    PropDef("x2", "svg:x2"),
    PropDef("y2", "svg:y2"),
    PropDef("line_skew", "draw:line-skew"),
    PropDef("svg_d", "svg:d"),
    PropDef("view_box", "svg:viewBox"),
)

_tag class-attribute instance-attribute

_tag = 'draw:connector'

connected_shapes property writable

connected_shapes: tuple[str | None, str | None]

Get or set the connected shapes (“draw:start-shape”, “draw:end-shape”).

draw_type property writable

draw_type: str

Get or set the draw type, “draw:type”.

glue_points property writable

glue_points: tuple[str | None, str | None]

Get or set the the glue points for connection (“draw:start-glue-point”, “draw:end-glue-point”).

line_skew instance-attribute

line_skew = line_skew

p1 property writable

p1: tuple[str | None, str | None]

Get or set the (x1, y1) coordinates of the starting point.

p2 property writable

p2: tuple[str | None, str | None]

Get or set the (x2, y2) coordinates of the ending point.

svg_d instance-attribute

svg_d = svg_d

view_box instance-attribute

view_box = view_box

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    connected_shapes: tuple[ShapeBase, ShapeBase]
    | list[ShapeBase]
    | None = None,
    glue_points: tuple[str | int, str | int]
    | list[str | int]
    | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    draw_type: str | None = None,
    line_skew: str | None = None,
    svg_d: str | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a connector shape “draw:connector”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the connector.	None
text_style	str | None	The text style name for the connector.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the connector.	None
connected_shapes	tuple[ShapeBase, ShapeBase] | list[ShapeBase] | None	A tuple of (start_shape, end_shape) where each shape is a shape with a draw_id.	None
glue_points	tuple[str | int, str | int] | list[str | int] | None	A tuple of (start_glue_point, end_glue_point) specifying the glue points for connection.	None
p1	tuple[str, str] | list[str] | None	The (x1, y1) coordinates of the starting point.	None
p2	tuple[str, str] | list[str] | None	The (x2, y2) coordinates of the ending point.	None
draw_type	str | None	The line or series of lines that connect two glue points. Values are ‘standard’ (default), ‘lines’, ‘line’ or ‘curve’.	None
line_skew	str | None	A list of offsets for the placements of connector lines if the connector is of type standard.	None
svg_d	str | None	A path data.	None
view_box	str | None	The rectangle in a local coordinates system used by the points.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    connected_shapes: tuple[ShapeBase, ShapeBase] | list[ShapeBase] | None = None,
    glue_points: tuple[str | int, str | int] | list[str | int] | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    draw_type: str | None = None,
    line_skew: str | None = None,
    svg_d: str | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a connector shape "draw:connector".

    Args:
        name: Name of the graphical element.
        style: The style name for the connector.
        text_style: The text style name for the connector.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the connector.
        connected_shapes: A tuple of (start_shape, end_shape)
            where each shape is a shape with a `draw_id`.
        glue_points: A tuple of (start_glue_point, end_glue_point)
            specifying the glue points for connection.
        p1: The (x1, y1) coordinates of the starting point.
        p2: The (x2, y2) coordinates of the ending point.
        draw_type: The line or series of lines that connect two glue
            points. Values are 'standard' (default), 'lines', 'line'
            or 'curve'.
        line_skew: A list of offsets for the placements of connector
            lines if the connector is of type standard.
        svg_d: A path data.
        view_box: The rectangle in a local coordinates system used by the
            points.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if connected_shapes:
            self.connected_shapes = connected_shapes
        if glue_points:
            self.glue_points = glue_points
        self.p1 = p1
        self.p2 = p2
        if draw_type:
            self.draw_type = draw_type
        if line_skew:
            self.line_skew = line_skew
        if svg_d:
            self.svg_d = svg_d
        if view_box:
            self.view_box = view_box

DrawCaption

Bases: PosMix, SizeMix, ShapeBase

Represents a description attached to a fixed point, “draw:caption”.

It consists of rectangular drawing shape with an additional set of connected lines that connect the rectangle with the fixed point.

Methods:

Name	Description
__init__	Create a draw caption “draw:caption”.

Attributes:

Name	Type	Description
caption_point	tuple[str | None, str | None]	Get or set the (caption_point_x, caption_point_y) coordinates of the
corner_radius
position
size

Source code in odfdo/shapes.py

class DrawCaption(PosMix, SizeMix, ShapeBase):
    """Represents a description attached to a fixed point, "draw:caption".

    It consists of rectangular drawing shape with an additional set of
    connected lines that connect the rectangle with the fixed point.
    """

    _tag = "draw:caption"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("caption_point_x", "draw:caption-point-x"),
        PropDef("caption_point_y", "draw:caption-point-y"),
        PropDef("corner_radius", "draw:corner-radius"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        caption_point: tuple[str, str] | list[str] | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        corner_radius: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a draw caption "draw:caption".

        Args:
            name: Name of the graphical element.
            style: The style name for the path.
            text_style: The text style name for the path.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the path.
            caption_point: The position of a point that is captioned. A set
                of lines is rendered to that point from the caption area.
            position: The (x, y) coordinates for the path's position.
            size: The (width, height) values for the path's size.
            corner_radius: radius of the circle used to round off the corners.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if position:
                self.position = position
            if size:
                self.size = size
            if corner_radius:
                self.corner_radius = corner_radius
            if caption_point:
                self.caption_point = caption_point

    @property
    def caption_point(self) -> tuple[str | None, str | None]:
        """Get or set the (caption_point_x, caption_point_y) coordinates of the
        caption point."""
        return (self.caption_point_x, self.caption_point_y)

    @caption_point.setter
    def caption_point(self, caption_point: tuple[str, str] | list[str] | None) -> None:
        if caption_point is None:
            self.caption_point_x = None
            self.caption_point_y = None
        else:
            self.caption_point_x = caption_point[0]
            self.caption_point_y = caption_point[1]

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("caption_point_x", "draw:caption-point-x"),
    PropDef("caption_point_y", "draw:caption-point-y"),
    PropDef("corner_radius", "draw:corner-radius"),
)

_tag class-attribute instance-attribute

_tag = 'draw:caption'

caption_point property writable

caption_point: tuple[str | None, str | None]

Get or set the (caption_point_x, caption_point_y) coordinates of the caption point.

corner_radius instance-attribute

corner_radius = corner_radius

position instance-attribute

position = position

size instance-attribute

size = size

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    caption_point: tuple[str, str]
    | list[str]
    | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    corner_radius: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a draw caption “draw:caption”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the path.	None
text_style	str | None	The text style name for the path.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the path.	None
caption_point	tuple[str, str] | list[str] | None	The position of a point that is captioned. A set of lines is rendered to that point from the caption area.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the path’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the path’s size.	None
corner_radius	str | None	radius of the circle used to round off the corners.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    caption_point: tuple[str, str] | list[str] | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    corner_radius: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a draw caption "draw:caption".

    Args:
        name: Name of the graphical element.
        style: The style name for the path.
        text_style: The text style name for the path.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the path.
        caption_point: The position of a point that is captioned. A set
            of lines is rendered to that point from the caption area.
        position: The (x, y) coordinates for the path's position.
        size: The (width, height) values for the path's size.
        corner_radius: radius of the circle used to round off the corners.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if position:
            self.position = position
        if size:
            self.size = size
        if corner_radius:
            self.corner_radius = corner_radius
        if caption_point:
            self.caption_point = caption_point

DrawControl

Bases: PosMix, SizeMix, ShapeBase

Represents a shape that is linked to a control inside an “office:forms” element, “draw:control”.

Methods:

Name	Description
__init__	Create a control shape “draw:control”.

Attributes:

Name	Type	Description
control
position
size

Source code in odfdo/shapes.py

class DrawControl(PosMix, SizeMix, ShapeBase):
    """Represents a shape that is linked to a control inside an
    "office:forms" element, "draw:control".
    """

    _tag = "draw:control"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("control", "draw:control"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        control: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a control shape "draw:control".

        Args:
            name: Name of the graphical element.
            style: The style name for the control.
            text_style: The text style name for the control.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the control.
            control: A control within a form that is linked to the control
                shape by its ID.
            position: The (x, y) coordinates for the control's position.
            size: The (width, height) values for the control's size.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if control:
                self.control = control
            if position:
                self.position = position
            if size:
                self.size = size

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("control", "draw:control"),
)

_tag class-attribute instance-attribute

_tag = 'draw:control'

control instance-attribute

control = control

position instance-attribute

position = position

size instance-attribute

size = size

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    control: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a control shape “draw:control”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the control.	None
text_style	str | None	The text style name for the control.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the control.	None
control	str | None	A control within a form that is linked to the control shape by its ID.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the control’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the control’s size.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    control: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a control shape "draw:control".

    Args:
        name: Name of the graphical element.
        style: The style name for the control.
        text_style: The text style name for the control.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the control.
        control: A control within a form that is linked to the control
            shape by its ID.
        position: The (x, y) coordinates for the control's position.
        size: The (width, height) values for the control's size.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if control:
            self.control = control
        if position:
            self.position = position
        if size:
            self.size = size

DrawGroup

Bases: SvgMixin, AnchorMix, ZMix, Element

Representation of a group of drawing shapes, “draw:g”.

Warning: implementation is currently minimal.

Drawing shapes contained by a “draw:g” element that is itself contained by a “draw:a” element, act as hyperlinks using the xlink:href attribute of the containing “draw:a” element. If the included drawing shapes are themselves contained within “draw:a” elements, then the xlink:href attributes of those “draw:a” elements act as the hyperlink information for the shapes they contain.

Methods:

Name	Description
__init__	Create a group of drawing shapes “draw:g”.
get_formatted_text	Return the formatted text content of the shape.

Attributes:

Name	Type	Description
anchor_page
anchor_type
caption_id
class_names
draw_id
end_cell_address
end_x
end_y
name
presentation_class
presentation_style
style
svg_y
table_background
xml_id
z_index

Source code in odfdo/shapes.py

class DrawGroup(SvgMixin, AnchorMix, ZMix, Element):
    """Representation of a group of drawing shapes, "draw:g".

    Warning: implementation is currently minimal.

    Drawing shapes contained by a "draw:g" element that is itself
    contained by a "draw:a" element, act as hyperlinks using the
    xlink:href attribute of the containing "draw:a" element. If the
    included drawing shapes are themselves contained within "draw:a"
    elements, then the xlink:href attributes of those "draw:a" elements
    act as the hyperlink information for the shapes they contain.
    """

    _tag = "draw:g"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("name", "draw:name"),
        PropDef("style", "draw:style-name"),
        PropDef("draw_id", "draw:id"),
        PropDef("svg_y", "svg:y"),
        PropDef("presentation_class", "presentation:class-names"),
        PropDef("presentation_style", "presentation:style-name"),
        PropDef("caption_id", "draw:caption-id"),
        PropDef("class_names", "draw:class-names"),
        PropDef("end_cell_address", "table:end-cell-address"),
        PropDef("end_x", "table:end-x"),
        PropDef("end_y", "table:end-y"),
        PropDefBool("table_background", "table:table-background", False),
        PropDef("xml_id", "xml:id"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        draw_id: str | None = None,
        svg_y: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a group of drawing shapes "draw:g".

        Args:
            name: Name of the group.
            style: The style name for the group.
            draw_id: The unique ID for the drawing group.
            svg_y: Position on the y-axis of the group.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        super().__init__(**kwargs)
        if self._do_init:
            if name:
                self.name = name
            if style:
                self.style = style
            if draw_id:
                self.draw_id = draw_id
            if svg_y:
                self.svg_y = svg_y
            if presentation_class:
                self.presentation_class = presentation_class
            if presentation_style:
                self.presentation_style = presentation_style
            if caption_id:
                self.caption_id = caption_id
            if class_names:
                self.class_names = class_names
            if z_index is not None:
                self.z_index = z_index
            if end_cell_address:
                self.end_cell_address = end_cell_address
            if end_x:
                self.end_x = end_x
            if end_y:
                self.end_y = end_y
            if table_background is not None:
                self.table_background = table_background
            if anchor_type:
                self.anchor_type = anchor_type
            if anchor_page is not None:
                self.anchor_page = anchor_page
            if xml_id:
                self.xml_id = xml_id

    def get_formatted_text(self, context: dict | None = None) -> str:
        """Return the formatted text content of the shape.

        Args:
            context: A dictionary of context variables.

        Returns:
            str: The formatted text content.
        """
        result: list[str] = []
        for child in self.children:
            result.append(child.get_formatted_text(context))
        result.append("\n")
        return "".join(result)

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "draw:name"),
    PropDef("style", "draw:style-name"),
    PropDef("draw_id", "draw:id"),
    PropDef("svg_y", "svg:y"),
    PropDef(
        "presentation_class", "presentation:class-names"
    ),
    PropDef(
        "presentation_style", "presentation:style-name"
    ),
    PropDef("caption_id", "draw:caption-id"),
    PropDef("class_names", "draw:class-names"),
    PropDef("end_cell_address", "table:end-cell-address"),
    PropDef("end_x", "table:end-x"),
    PropDef("end_y", "table:end-y"),
    PropDefBool(
        "table_background", "table:table-background", False
    ),
    PropDef("xml_id", "xml:id"),
)

_tag class-attribute instance-attribute

_tag = 'draw:g'

anchor_page instance-attribute

anchor_page = anchor_page

anchor_type instance-attribute

anchor_type = anchor_type

caption_id instance-attribute

caption_id = caption_id

class_names instance-attribute

class_names = class_names

draw_id instance-attribute

draw_id = draw_id

end_cell_address instance-attribute

end_cell_address = end_cell_address

end_x instance-attribute

end_x = end_x

end_y instance-attribute

end_y = end_y

name instance-attribute

name = name

presentation_class instance-attribute

presentation_class = presentation_class

presentation_style instance-attribute

presentation_style = presentation_style

style instance-attribute

style = style

svg_y instance-attribute

svg_y = svg_y

table_background instance-attribute

table_background = table_background

xml_id instance-attribute

xml_id = xml_id

z_index instance-attribute

z_index = z_index

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    draw_id: str | None = None,
    svg_y: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a group of drawing shapes “draw:g”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the group.	None
style	str | None	The style name for the group.	None
draw_id	str | None	The unique ID for the drawing group.	None
svg_y	str | None	Position on the y-axis of the group.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    draw_id: str | None = None,
    svg_y: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a group of drawing shapes "draw:g".

    Args:
        name: Name of the group.
        style: The style name for the group.
        draw_id: The unique ID for the drawing group.
        svg_y: Position on the y-axis of the group.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    super().__init__(**kwargs)
    if self._do_init:
        if name:
            self.name = name
        if style:
            self.style = style
        if draw_id:
            self.draw_id = draw_id
        if svg_y:
            self.svg_y = svg_y
        if presentation_class:
            self.presentation_class = presentation_class
        if presentation_style:
            self.presentation_style = presentation_style
        if caption_id:
            self.caption_id = caption_id
        if class_names:
            self.class_names = class_names
        if z_index is not None:
            self.z_index = z_index
        if end_cell_address:
            self.end_cell_address = end_cell_address
        if end_x:
            self.end_x = end_x
        if end_y:
            self.end_y = end_y
        if table_background is not None:
            self.table_background = table_background
        if anchor_type:
            self.anchor_type = anchor_type
        if anchor_page is not None:
            self.anchor_page = anchor_page
        if xml_id:
            self.xml_id = xml_id

get_formatted_text

get_formatted_text(context: dict | None = None) -> str

Return the formatted text content of the shape.

Parameters:

Name	Type	Description	Default
context	dict | None	A dictionary of context variables.	None

Returns:

Name	Type	Description
str	str	The formatted text content.

Source code in odfdo/shapes.py

def get_formatted_text(self, context: dict | None = None) -> str:
    """Return the formatted text content of the shape.

    Args:
        context: A dictionary of context variables.

    Returns:
        str: The formatted text content.
    """
    result: list[str] = []
    for child in self.children:
        result.append(child.get_formatted_text(context))
    result.append("\n")
    return "".join(result)

DrawMeasure

Bases: LineShape

Represents a shape that is used to measure distances in drawings, “draw:measure”.

Methods:

Name	Description
__init__	Create a line shape “draw:line”.

Source code in odfdo/shapes.py

class DrawMeasure(LineShape):
    """Represents a shape that is used to measure distances in drawings,
    "draw:measure".
    """

    _tag = "draw:measure"

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        p1: tuple[str, str] | list[str] | None = None,
        p2: tuple[str, str] | list[str] | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a line shape "draw:line".

        Args:
            name: Name of the graphical element.
            style: The style name for the measure.
            text_style: The text style name for the measure.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the measure.
            p1: The (x1, y1) coordinates of the starting point.
            p2: The (x2, y2) coordinates of the ending point.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "p1": p1,
                "p2": p2,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)

_tag class-attribute instance-attribute

_tag = 'draw:measure'

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a line shape “draw:line”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the measure.	None
text_style	str | None	The text style name for the measure.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the measure.	None
p1	tuple[str, str] | list[str] | None	The (x1, y1) coordinates of the starting point.	None
p2	tuple[str, str] | list[str] | None	The (x2, y2) coordinates of the ending point.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a line shape "draw:line".

    Args:
        name: Name of the graphical element.
        style: The style name for the measure.
        text_style: The text style name for the measure.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the measure.
        p1: The (x1, y1) coordinates of the starting point.
        p2: The (x2, y2) coordinates of the ending point.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "p1": p1,
            "p2": p2,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)

DrawPageThumbnail

Bases: PosMix, SizeMix, ShapeBase

Represents a rectangular area that displays the thumbnail of a drawing page, “draw:page-thumbnail”.

Methods:

Name	Description
__init__	Create a control shape “draw:page-thumbnail”.

Attributes:

Name	Type	Description
page_number	int | None	Get or set the number of a page that is displayed as a thumbnail.
placeholder
position
size
user_transformed

Source code in odfdo/shapes.py

class DrawPageThumbnail(PosMix, SizeMix, ShapeBase):
    """Represents a rectangular area that displays the thumbnail of a
    drawing page, "draw:page-thumbnail".
    """

    _tag = "draw:page-thumbnail"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDefBool("placeholder", "presentation:placeholder", False),
        PropDef("user_transformed", "presentation:user-transformed"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        page_number: int | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        placeholder: bool | None = None,
        user_transformed: bool | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a control shape "draw:page-thumbnail".

        Args:
            name: Name of the graphical element.
            style: The style name for the control.
            text_style: The text style name for the control.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the control.
            page_number: The number of a page that is displayed as a
                thumbnail.
            position: The (x, y) coordinates for the control's position.
            size: The (width, height) values for the control's size.
            placeholder: True if shape is a placeholder.
            user_transformed: Whether the size and position of the shape
                is set by the user or is set by the corresponding
                presentation shape on the master page.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if page_number:
                self.page_number = page_number
            if position:
                self.position = position
            if size:
                self.size = size
            if placeholder is not None:
                self.placeholder = placeholder
            if user_transformed is not None:
                self.user_transformed = user_transformed

    @property
    def page_number(self) -> int | None:
        """Get or set the number of a page that is displayed as a thumbnail.

        type : int or None
        """
        page_number = self.get_attribute("draw:page-number")
        if page_number is None:
            return None
        return int(page_number)

    @page_number.setter
    def page_number(self, page_number: int | None) -> None:
        self._set_attribute_int("draw:page-number", page_number)

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDefBool(
        "placeholder", "presentation:placeholder", False
    ),
    PropDef(
        "user_transformed", "presentation:user-transformed"
    ),
)

_tag class-attribute instance-attribute

_tag = 'draw:page-thumbnail'

page_number property writable

page_number: int | None

Get or set the number of a page that is displayed as a thumbnail.

type : int or None

placeholder instance-attribute

placeholder = placeholder

position instance-attribute

position = position

size instance-attribute

size = size

user_transformed instance-attribute

user_transformed = user_transformed

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    page_number: int | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    placeholder: bool | None = None,
    user_transformed: bool | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a control shape “draw:page-thumbnail”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the control.	None
text_style	str | None	The text style name for the control.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the control.	None
page_number	int | None	The number of a page that is displayed as a thumbnail.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the control’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the control’s size.	None
placeholder	bool | None	True if shape is a placeholder.	None
user_transformed	bool | None	Whether the size and position of the shape is set by the user or is set by the corresponding presentation shape on the master page.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    page_number: int | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    placeholder: bool | None = None,
    user_transformed: bool | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a control shape "draw:page-thumbnail".

    Args:
        name: Name of the graphical element.
        style: The style name for the control.
        text_style: The text style name for the control.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the control.
        page_number: The number of a page that is displayed as a
            thumbnail.
        position: The (x, y) coordinates for the control's position.
        size: The (width, height) values for the control's size.
        placeholder: True if shape is a placeholder.
        user_transformed: Whether the size and position of the shape
            is set by the user or is set by the corresponding
            presentation shape on the master page.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if page_number:
            self.page_number = page_number
        if position:
            self.position = position
        if size:
            self.size = size
        if placeholder is not None:
            self.placeholder = placeholder
        if user_transformed is not None:
            self.user_transformed = user_transformed

DrawPath

Bases: PosMix, SizeMix, ShapeBase

Represents a path, “draw:path”.

A path is a shape with a user-defined outline. The outline is defined by the svg:d attribute.

Methods:

Name	Description
__init__	Create a path shape “draw:path”.

Attributes:

Name	Type	Description
position
size
svg_d
view_box

Source code in odfdo/shapes.py

class DrawPath(PosMix, SizeMix, ShapeBase):
    """Represents a path, "draw:path".

    A path is a shape with a user-defined outline. The outline is defined by
    the svg:d attribute.
    """

    _tag = "draw:path"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("svg_d", "svg:d"),
        PropDef("view_box", "svg:viewBox"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        svg_d: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        view_box: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a path shape "draw:path".

        Args:
            name: Name of the graphical element.
            style: The style name for the path.
            text_style: The text style name for the path.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the path.
            svg_d: A path data.
            position: The (x, y) coordinates for the path's position.
            size: The (width, height) values for the path's size.
            view_box: The rectangle in a local coordinates system used by the
                points.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if svg_d:
                self.svg_d = svg_d
            if position:
                self.position = position
            if size:
                self.size = size
            if view_box:
                self.view_box = view_box

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("svg_d", "svg:d"),
    PropDef("view_box", "svg:viewBox"),
)

_tag class-attribute instance-attribute

_tag = 'draw:path'

position instance-attribute

position = position

size instance-attribute

size = size

svg_d instance-attribute

svg_d = svg_d

view_box instance-attribute

view_box = view_box

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    svg_d: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a path shape “draw:path”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the path.	None
text_style	str | None	The text style name for the path.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the path.	None
svg_d	str | None	A path data.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the path’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the path’s size.	None
view_box	str | None	The rectangle in a local coordinates system used by the points.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    svg_d: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a path shape "draw:path".

    Args:
        name: Name of the graphical element.
        style: The style name for the path.
        text_style: The text style name for the path.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the path.
        svg_d: A path data.
        position: The (x, y) coordinates for the path's position.
        size: The (width, height) values for the path's size.
        view_box: The rectangle in a local coordinates system used by the
            points.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if svg_d:
            self.svg_d = svg_d
        if position:
            self.position = position
        if size:
            self.size = size
        if view_box:
            self.view_box = view_box

EllipseShape

Bases: AngleMix, PosMix, SizeMix, ShapeBase

Represents an ellipse shape, “draw:ellipse”.

This shape defines an elliptical or circular area.

Methods:

Name	Description
__init__	Create an ellipse shape “draw:ellipse”.

Attributes:

Name	Type	Description
cx
cy
end_angle
kind
position
rx
ry
size
start_angle

Source code in odfdo/shapes.py

class EllipseShape(AngleMix, PosMix, SizeMix, ShapeBase):
    """Represents an ellipse shape, "draw:ellipse".

    This shape defines an elliptical or circular area.
    """

    _tag = "draw:ellipse"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("cx", "svg:cx"),
        PropDef("cy", "svg:cy"),
        PropDef("rx", "svg:rx"),
        PropDef("ry", "svg:ry"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        kind: str | None = None,
        start_angle: str | None = None,
        end_angle: str | None = None,
        cx: str | None = None,
        cy: str | None = None,
        rx: str | None = None,
        ry: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create an ellipse shape "draw:ellipse".

        Args:
            name: Name of the graphical element.
            style: The style name for the ellipse.
            text_style: The text style name for the ellipse.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the ellipse.
            position: The (x, y) coordinates for the ellipse's position.
            size: The (width, height) for the ellipse's size.
            kind: The appearance of a circle or ellipse, "full", "section",
                "cut" or "arc". Default is "full".
            start_angle: The start angle of a section, cut, or arc where the
                draw:kind is "section", "cut" or "arc".
            end_angle: The end angle of a section, cut, or arc where the
                draw:kind is "section", "cut" or "arc".
            cx: The x-axis coordinate of the center of a circular image map
                area.
            cy: The y-axis coordinate of the center of a circular image map
                area.
            rx: The x-axis radius of the ellipse.
            ry: The y-axis radius of the ellipse.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if position:
                self.position = position
            if size:
                self.size = size
            if kind:
                self.kind = kind
            if start_angle:
                self.start_angle = start_angle
            if end_angle:
                self.end_angle = end_angle
            if cx:
                self.cx = cx
            if cy:
                self.cy = cy
            if rx:
                self.rx = rx
            if ry:
                self.ry = ry

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("cx", "svg:cx"),
    PropDef("cy", "svg:cy"),
    PropDef("rx", "svg:rx"),
    PropDef("ry", "svg:ry"),
)

_tag class-attribute instance-attribute

_tag = 'draw:ellipse'

cx instance-attribute

cx = cx

cy instance-attribute

cy = cy

end_angle instance-attribute

end_angle = end_angle

kind instance-attribute

kind = kind

position instance-attribute

position = position

rx instance-attribute

rx = rx

ry instance-attribute

ry = ry

size instance-attribute

size = size

start_angle instance-attribute

start_angle = start_angle

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    kind: str | None = None,
    start_angle: str | None = None,
    end_angle: str | None = None,
    cx: str | None = None,
    cy: str | None = None,
    rx: str | None = None,
    ry: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create an ellipse shape “draw:ellipse”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the ellipse.	None
text_style	str | None	The text style name for the ellipse.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the ellipse.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the ellipse’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) for the ellipse’s size.	None
kind	str | None	The appearance of a circle or ellipse, “full”, “section”, “cut” or “arc”. Default is “full”.	None
start_angle	str | None	The start angle of a section, cut, or arc where the draw:kind is “section”, “cut” or “arc”.	None
end_angle	str | None	The end angle of a section, cut, or arc where the draw:kind is “section”, “cut” or “arc”.	None
cx	str | None	The x-axis coordinate of the center of a circular image map area.	None
cy	str | None	The y-axis coordinate of the center of a circular image map area.	None
rx	str | None	The x-axis radius of the ellipse.	None
ry	str | None	The y-axis radius of the ellipse.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    kind: str | None = None,
    start_angle: str | None = None,
    end_angle: str | None = None,
    cx: str | None = None,
    cy: str | None = None,
    rx: str | None = None,
    ry: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create an ellipse shape "draw:ellipse".

    Args:
        name: Name of the graphical element.
        style: The style name for the ellipse.
        text_style: The text style name for the ellipse.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the ellipse.
        position: The (x, y) coordinates for the ellipse's position.
        size: The (width, height) for the ellipse's size.
        kind: The appearance of a circle or ellipse, "full", "section",
            "cut" or "arc". Default is "full".
        start_angle: The start angle of a section, cut, or arc where the
            draw:kind is "section", "cut" or "arc".
        end_angle: The end angle of a section, cut, or arc where the
            draw:kind is "section", "cut" or "arc".
        cx: The x-axis coordinate of the center of a circular image map
            area.
        cy: The y-axis coordinate of the center of a circular image map
            area.
        rx: The x-axis radius of the ellipse.
        ry: The y-axis radius of the ellipse.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if position:
            self.position = position
        if size:
            self.size = size
        if kind:
            self.kind = kind
        if start_angle:
            self.start_angle = start_angle
        if end_angle:
            self.end_angle = end_angle
        if cx:
            self.cx = cx
        if cy:
            self.cy = cy
        if rx:
            self.rx = rx
        if ry:
            self.ry = ry

LineShape

Bases: ShapeBase

Represents a line shape, “draw:line”.

This shape defines a straight line between two points.

Methods:

Name	Description
__init__	Create a line shape “draw:line”.

Attributes:

Name	Type	Description
p1	tuple[str | None, str | None]	Get or set the (x1, y1) coordinates of the starting point.
p2	tuple[str | None, str | None]	Get or set the (x2, y2) coordinates of the ending point.

Source code in odfdo/shapes.py

class LineShape(ShapeBase):
    """Represents a line shape, "draw:line".

    This shape defines a straight line between two points.
    """

    _tag = "draw:line"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("x1", "svg:x1"),
        PropDef("y1", "svg:y1"),
        PropDef("x2", "svg:x2"),
        PropDef("y2", "svg:y2"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        p1: tuple[str, str] | list[str] | None = None,
        p2: tuple[str, str] | list[str] | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a line shape "draw:line".

        Args:
            name: Name of the graphical element.
            style: The style name for the line.
            text_style: The text style name for the line.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the line.
            p1: The (x1, y1) coordinates of the starting point.
            p2: The (x2, y2) coordinates of the ending point.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            self.p1 = p1
            self.p2 = p2

    @property
    def p1(self) -> tuple[str | None, str | None]:
        "Get or set the (x1, y1) coordinates of the starting point."
        return (self.x1, self.y1)

    @p1.setter
    def p1(self, p1: tuple[str, str] | list[str] | None) -> None:
        if p1 is None:
            self.x1 = None
            self.y1 = None
        else:
            self.x1 = p1[0]
            self.y1 = p1[1]

    @property
    def p2(self) -> tuple[str | None, str | None]:
        "Get or set the (x2, y2) coordinates of the ending point."
        return (self.x2, self.y2)

    @p2.setter
    def p2(self, p2: tuple[str, str] | list[str] | None) -> None:
        if p2 is None:
            self.x2 = None
            self.y2 = None
        else:
            self.x2 = p2[0]
            self.y2 = p2[1]

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("x1", "svg:x1"),
    PropDef("y1", "svg:y1"),
    PropDef("x2", "svg:x2"),
    PropDef("y2", "svg:y2"),
)

_tag class-attribute instance-attribute

_tag = 'draw:line'

p1 property writable

p1: tuple[str | None, str | None]

Get or set the (x1, y1) coordinates of the starting point.

p2 property writable

p2: tuple[str | None, str | None]

Get or set the (x2, y2) coordinates of the ending point.

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a line shape “draw:line”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the line.	None
text_style	str | None	The text style name for the line.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the line.	None
p1	tuple[str, str] | list[str] | None	The (x1, y1) coordinates of the starting point.	None
p2	tuple[str, str] | list[str] | None	The (x2, y2) coordinates of the ending point.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    p1: tuple[str, str] | list[str] | None = None,
    p2: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a line shape "draw:line".

    Args:
        name: Name of the graphical element.
        style: The style name for the line.
        text_style: The text style name for the line.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the line.
        p1: The (x1, y1) coordinates of the starting point.
        p2: The (x2, y2) coordinates of the ending point.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        self.p1 = p1
        self.p2 = p2

PolygonShape

Bases: PolylineShape

Represents a polygon, “draw:polygon”.

A polygon is a closed set of straight lines.

Methods:

Name	Description
__init__	Create a polygon shape “draw:polygon>”.

Source code in odfdo/shapes.py

class PolygonShape(PolylineShape):
    """Represents a polygon, "draw:polygon".

    A polygon is a closed set of straight lines."""

    _tag = "draw:polygon"

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        points: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        view_box: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a polygon shape "draw:polygon>".

        Args:
            name: Name of the graphical element.
            style: The style name for the polygon.
            text_style: The text style name for the polygon.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the polygon.
            points: The coordinates of the polygon.
            position: The (x, y) coordinates for the polygon's position.
            size: The (width, height) values for the polygon's size.
            view_box: The rectangle in a local coordinates system used by the
                points.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "points": points,
                "position": position,
                "size": size,
                "view_box": view_box,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)

_tag class-attribute instance-attribute

_tag = 'draw:polygon'

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    points: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a polygon shape “draw:polygon>”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the polygon.	None
text_style	str | None	The text style name for the polygon.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the polygon.	None
points	str | None	The coordinates of the polygon.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the polygon’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the polygon’s size.	None
view_box	str | None	The rectangle in a local coordinates system used by the points.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    points: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a polygon shape "draw:polygon>".

    Args:
        name: Name of the graphical element.
        style: The style name for the polygon.
        text_style: The text style name for the polygon.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the polygon.
        points: The coordinates of the polygon.
        position: The (x, y) coordinates for the polygon's position.
        size: The (width, height) values for the polygon's size.
        view_box: The rectangle in a local coordinates system used by the
            points.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "points": points,
            "position": position,
            "size": size,
            "view_box": view_box,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)

PolylineShape

Bases: PosMix, SizeMix, ShapeBase

Represents a polyline shape, “draw:polyline”.

Methods:

Name	Description
__init__	Create a polyline shape “draw:polyline”.

Attributes:

Name	Type	Description
points
position
size
view_box

Source code in odfdo/shapes.py

class PolylineShape(PosMix, SizeMix, ShapeBase):
    """Represents a polyline shape, "draw:polyline"."""

    _tag = "draw:polyline"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("points", "draw:points"),
        PropDef("view_box", "svg:viewBox"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        points: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        view_box: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a polyline shape "draw:polyline".

        Args:
            name: Name of the graphical element.
            style: The style name for the polyline.
            text_style: The text style name for the polyline.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the polyline.
            points: The coordinates of the polyline.
            position: The (x, y) coordinates for the polyline's position.
            size: The (width, height) values for the polyline's size.
            view_box: The rectangle in a local coordinates system used by the
                points.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if points:
                self.points = points
            if position:
                self.position = position
            if size:
                self.size = size
            if view_box:
                self.view_box = view_box

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("points", "draw:points"),
    PropDef("view_box", "svg:viewBox"),
)

_tag class-attribute instance-attribute

_tag = 'draw:polyline'

points instance-attribute

points = points

position instance-attribute

position = position

size instance-attribute

size = size

view_box instance-attribute

view_box = view_box

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    points: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a polyline shape “draw:polyline”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the polyline.	None
text_style	str | None	The text style name for the polyline.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the polyline.	None
points	str | None	The coordinates of the polyline.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the polyline’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the polyline’s size.	None
view_box	str | None	The rectangle in a local coordinates system used by the points.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    points: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    view_box: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a polyline shape "draw:polyline".

    Args:
        name: Name of the graphical element.
        style: The style name for the polyline.
        text_style: The text style name for the polyline.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the polyline.
        points: The coordinates of the polyline.
        position: The (x, y) coordinates for the polyline's position.
        size: The (width, height) values for the polyline's size.
        view_box: The rectangle in a local coordinates system used by the
            points.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if points:
            self.points = points
        if position:
            self.position = position
        if size:
            self.size = size
        if view_box:
            self.view_box = view_box

RectangleShape

Bases: PosMix, SizeMix, ShapeBase

Represents a rectangle shape, “draw:rect”.

This shape defines a rectangular area.

Methods:

Name	Description
__init__	Create a rectangle shape “draw:rect”.

Attributes:

Name	Type	Description
corner_radius
position
rx
ry
size

Source code in odfdo/shapes.py

class RectangleShape(PosMix, SizeMix, ShapeBase):
    """Represents a rectangle shape, "draw:rect".

    This shape defines a rectangular area.
    """

    _tag = "draw:rect"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("corner_radius", "draw:corner-radius"),
        PropDef("rx", "svg:rx"),
        PropDef("ry", "svg:ry"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        corner_radius: str | None = None,
        rx: str | None = None,
        ry: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a rectangle shape "draw:rect".

        Args:
            name: Name of the graphical element.
            style: The style name for the rectangle.
            text_style: The text style name for the rectangle.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the rectangle.
            position: The (x, y) coordinates for the rectangle's position.
            size: The (width, height) values for the rectangle's size.
            corner_radius: radius of the circle used to round off the corners.
            rx: x-axis radius of the ellipse used to round off the corners.
            ry: y-axis radius of the ellipse used to round off the corners.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if position:
                self.position = position
            if size:
                self.size = size
            if corner_radius:
                self.corner_radius = corner_radius
            if rx:
                self.rx = rx
            if ry:
                self.ry = ry

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("corner_radius", "draw:corner-radius"),
    PropDef("rx", "svg:rx"),
    PropDef("ry", "svg:ry"),
)

_tag class-attribute instance-attribute

_tag = 'draw:rect'

corner_radius instance-attribute

corner_radius = corner_radius

position instance-attribute

position = position

rx instance-attribute

rx = rx

ry instance-attribute

ry = ry

size instance-attribute

size = size

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    corner_radius: str | None = None,
    rx: str | None = None,
    ry: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a rectangle shape “draw:rect”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the rectangle.	None
text_style	str | None	The text style name for the rectangle.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the rectangle.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the rectangle’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the rectangle’s size.	None
corner_radius	str | None	radius of the circle used to round off the corners.	None
rx	str | None	x-axis radius of the ellipse used to round off the corners.	None
ry	str | None	y-axis radius of the ellipse used to round off the corners.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    corner_radius: str | None = None,
    rx: str | None = None,
    ry: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a rectangle shape "draw:rect".

    Args:
        name: Name of the graphical element.
        style: The style name for the rectangle.
        text_style: The text style name for the rectangle.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the rectangle.
        position: The (x, y) coordinates for the rectangle's position.
        size: The (width, height) values for the rectangle's size.
        corner_radius: radius of the circle used to round off the corners.
        rx: x-axis radius of the ellipse used to round off the corners.
        ry: y-axis radius of the ellipse used to round off the corners.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if position:
            self.position = position
        if size:
            self.size = size
        if corner_radius:
            self.corner_radius = corner_radius
        if rx:
            self.rx = rx
        if ry:
            self.ry = ry

RegularPolygonShape

Bases: PosMix, SizeMix, ShapeBase

Represents a regular polygon, “draw:regular-polygon”.

A regular polygon is a polygon that is specified by its number of edges (that is equal to the number of its corners), rather than by arbitrary points.

Methods:

Name	Description
__init__	Create a regular polygon shape “draw:regular-polygon”.

Attributes:

Name	Type	Description
concave
corners	int | None	Get or set the number of polygon corners.
position
sharpness
size

Source code in odfdo/shapes.py

class RegularPolygonShape(PosMix, SizeMix, ShapeBase):
    """Represents a regular polygon, "draw:regular-polygon".

    A regular polygon is a polygon that is specified by its number of edges
    (that is equal to the number of its corners), rather than by arbitrary
    points."""

    _tag = "draw:regular-polygon"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDefBool("concave", "draw:concave", False),
        PropDef("sharpness", "draw:sharpness"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        corners: int | None = None,
        concave: bool | None = None,
        sharpness: str | None = None,
        position: tuple[str, str] | list[str] | None = None,
        size: tuple[str, str] | list[str] | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a regular polygon shape "draw:regular-polygon".

        Args:
            name: Name of the graphical element.
            style: The style name for the polygon.
            text_style: The text style name for the polygon.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the polygon.
            corners: The number of polygon corners.
            concave: Whether a regular polygon is convex or concave.
            sharpness: The radius of the ellipse on which inner polygon
                corners are located for concave polygon.
            position: The (x, y) coordinates for the polygon's position.
            size: The (width, height) values for the polygon's size.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        kwargs.update(
            {
                "name": name,
                "style": style,
                "text_style": text_style,
                "draw_id": draw_id,
                "layer": layer,
                "presentation_class": presentation_class,
                "presentation_style": presentation_style,
                "caption_id": caption_id,
                "class_names": class_names,
                "transform": transform,
                "z_index": z_index,
                "end_cell_address": end_cell_address,
                "end_x": end_x,
                "end_y": end_y,
                "table_background": table_background,
                "anchor_type": anchor_type,
                "anchor_page": anchor_page,
                "xml_id": xml_id,
            }
        )
        super().__init__(**kwargs)
        if self._do_init:
            if corners:
                self.corners = corners
            if concave is not None:
                self.concave = concave
            if sharpness:
                self.sharpness = sharpness
            if position:
                self.position = position
            if size:
                self.size = size

    @property
    def corners(self) -> int | None:
        """Get or set the number of polygon corners.

        type : int or None
        """
        corners = self.get_attribute("draw:corners")
        if corners is None:
            return None
        return int(corners)

    @corners.setter
    def corners(self, corners: int | None) -> None:
        self._set_attribute_int("draw:corners", corners)

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDefBool("concave", "draw:concave", False),
    PropDef("sharpness", "draw:sharpness"),
)

_tag class-attribute instance-attribute

_tag = 'draw:regular-polygon'

concave instance-attribute

concave = concave

corners property writable

corners: int | None

Get or set the number of polygon corners.

type : int or None

position instance-attribute

position = position

sharpness instance-attribute

sharpness = sharpness

size instance-attribute

size = size

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    corners: int | None = None,
    concave: bool | None = None,
    sharpness: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Create a regular polygon shape “draw:regular-polygon”.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the polygon.	None
text_style	str | None	The text style name for the polygon.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the polygon.	None
corners	int | None	The number of polygon corners.	None
concave	bool | None	Whether a regular polygon is convex or concave.	None
sharpness	str | None	The radius of the ellipse on which inner polygon corners are located for concave polygon.	None
position	tuple[str, str] | list[str] | None	The (x, y) coordinates for the polygon’s position.	None
size	tuple[str, str] | list[str] | None	The (width, height) values for the polygon’s size.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    corners: int | None = None,
    concave: bool | None = None,
    sharpness: str | None = None,
    position: tuple[str, str] | list[str] | None = None,
    size: tuple[str, str] | list[str] | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Create a regular polygon shape "draw:regular-polygon".

    Args:
        name: Name of the graphical element.
        style: The style name for the polygon.
        text_style: The text style name for the polygon.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the polygon.
        corners: The number of polygon corners.
        concave: Whether a regular polygon is convex or concave.
        sharpness: The radius of the ellipse on which inner polygon
            corners are located for concave polygon.
        position: The (x, y) coordinates for the polygon's position.
        size: The (width, height) values for the polygon's size.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    kwargs.update(
        {
            "name": name,
            "style": style,
            "text_style": text_style,
            "draw_id": draw_id,
            "layer": layer,
            "presentation_class": presentation_class,
            "presentation_style": presentation_style,
            "caption_id": caption_id,
            "class_names": class_names,
            "transform": transform,
            "z_index": z_index,
            "end_cell_address": end_cell_address,
            "end_x": end_x,
            "end_y": end_y,
            "table_background": table_background,
            "anchor_type": anchor_type,
            "anchor_page": anchor_page,
            "xml_id": xml_id,
        }
    )
    super().__init__(**kwargs)
    if self._do_init:
        if corners:
            self.corners = corners
        if concave is not None:
            self.concave = concave
        if sharpness:
            self.sharpness = sharpness
        if position:
            self.position = position
        if size:
            self.size = size

ShapeBase

Bases: ListMixin, AnchorMix, SvgMixin, ZMix, Element

Base class for all drawing shapes.

This class provides common properties and methods for various shapes like lines, rectangles, ellipses, and connectors. It integrates sizing functionalities through mixins.

Methods:

Name	Description
__init__	Initialize a ShapeBase element.
get_formatted_text	Return the formatted text content of the shape.

Attributes:

Name	Type	Description
anchor_page
anchor_type
caption_id
class_names
draw_id
end_cell_address
end_x
end_y
layer
name
presentation_class
presentation_style
style
table_background
text_style
transform
xml_id
z_index

Source code in odfdo/shapes.py

class ShapeBase(ListMixin, AnchorMix, SvgMixin, ZMix, Element):
    """Base class for all drawing shapes.

    This class provides common properties and methods for various shapes
    like lines, rectangles, ellipses, and connectors. It integrates sizing
    functionalities through mixins.
    """

    _tag = "draw:shape-odfdo-notodf"
    _properties: tuple[PropDef | PropDefBool, ...] = (
        PropDef("name", "draw:name"),
        PropDef("draw_id", "draw:id"),
        PropDef("layer", "draw:layer"),
        PropDef("presentation_class", "presentation:class-names"),
        PropDef("presentation_style", "presentation:style-name"),
        PropDef("style", "draw:style-name"),
        PropDef("text_style", "draw:text-style-name"),
        PropDef("caption_id", "draw:caption-id"),
        PropDef("class_names", "draw:class-names"),
        PropDef("transform", "draw:transform"),
        PropDef("end_cell_address", "table:end-cell-address"),
        PropDef("end_x", "table:end-x"),
        PropDef("end_y", "table:end-y"),
        PropDefBool("table_background", "table:table-background", False),
        PropDef("xml_id", "xml:id"),
    )

    def __init__(
        self,
        name: str | None = None,
        style: str | None = None,
        text_style: str | None = None,
        draw_id: str | None = None,
        layer: str | None = None,
        presentation_class: str | None = None,
        presentation_style: str | None = None,
        caption_id: str | None = None,
        class_names: str | None = None,
        transform: str | None = None,
        z_index: int | None = None,
        end_cell_address: str | None = None,
        end_x: str | None = None,
        end_y: str | None = None,
        table_background: bool | None = None,
        anchor_type: str | None = None,
        anchor_page: int | None = None,
        xml_id: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Initialize a ShapeBase element.

        Args:
            name: Name of the graphical element.
            style: The style name for the shape.
            text_style: The text style name for the shape.
            draw_id: The unique ID for the drawing shape.
            layer: The drawing layer of the shape.
            presentation_class: White-space-separated list of presentation
                class names.
            presentation_style: Style for a presentation shape.
            caption_id: Target ID assigned to the "draw:text-box" that
                contains the caption.
            class_names: White-space-separated list of styles with the
                family value of graphic.
            transform: White-space or comma separated list of transform
                definitions.
            z_index: Rendering order for shapes in a document instance.
            end_cell_address: End position of the shape if it is included
                in a spreadsheet document.
            end_x: The x-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            end_y: The y-coordinate of the end position of a shape relative
                to the top-left edge of a cell.
            table_background: Wether the shape is in the table background if
                the drawing shape is included in a spreadsheet.
            anchor_type: How a drawing shape is bound to a text document.
            anchor_page: Physical page number of an anchor if the drawing
                object is bound to a page within a text document.
            xml_id: The unique XML ID.
        """
        super().__init__(**kwargs)
        if self._do_init:
            if name:
                self.name = name
            if style:
                self.style = style
            if text_style:
                self.text_style = text_style
            if draw_id:
                self.draw_id = draw_id
            if layer:
                self.layer = layer
            if presentation_class:
                self.presentation_class = presentation_class
            if presentation_style:
                self.presentation_style = presentation_style
            if caption_id:
                self.caption_id = caption_id
            if class_names:
                self.class_names = class_names
            if transform:
                self.transform = transform
            if z_index is not None:
                self.z_index = z_index
            if end_cell_address:
                self.end_cell_address = end_cell_address
            if end_x:
                self.end_x = end_x
            if end_y:
                self.end_y = end_y
            if table_background is not None:
                self.table_background = table_background
            if anchor_type:
                self.anchor_type = anchor_type
            if anchor_page is not None:
                self.anchor_page = anchor_page
            if xml_id:
                self.xml_id = xml_id

    def get_formatted_text(self, context: dict | None = None) -> str:
        """Return the formatted text content of the shape.

        Args:
            context: A dictionary of context variables.

        Returns:
            str: The formatted text content.
        """
        result: list[str] = []
        for child in self.children:
            result.append(child.get_formatted_text(context))
        result.append("\n")
        return "".join(result)

_properties class-attribute instance-attribute

_properties: tuple[PropDef | PropDefBool, ...] = (
    PropDef("name", "draw:name"),
    PropDef("draw_id", "draw:id"),
    PropDef("layer", "draw:layer"),
    PropDef(
        "presentation_class", "presentation:class-names"
    ),
    PropDef(
        "presentation_style", "presentation:style-name"
    ),
    PropDef("style", "draw:style-name"),
    PropDef("text_style", "draw:text-style-name"),
    PropDef("caption_id", "draw:caption-id"),
    PropDef("class_names", "draw:class-names"),
    PropDef("transform", "draw:transform"),
    PropDef("end_cell_address", "table:end-cell-address"),
    PropDef("end_x", "table:end-x"),
    PropDef("end_y", "table:end-y"),
    PropDefBool(
        "table_background", "table:table-background", False
    ),
    PropDef("xml_id", "xml:id"),
)

_tag class-attribute instance-attribute

_tag = 'draw:shape-odfdo-notodf'

anchor_page instance-attribute

anchor_page = anchor_page

anchor_type instance-attribute

anchor_type = anchor_type

caption_id instance-attribute

caption_id = caption_id

class_names instance-attribute

class_names = class_names

draw_id instance-attribute

draw_id = draw_id

end_cell_address instance-attribute

end_cell_address = end_cell_address

end_x instance-attribute

end_x = end_x

end_y instance-attribute

end_y = end_y

layer instance-attribute

layer = layer

name instance-attribute

name = name

presentation_class instance-attribute

presentation_class = presentation_class

presentation_style instance-attribute

presentation_style = presentation_style

style instance-attribute

style = style

table_background instance-attribute

table_background = table_background

text_style instance-attribute

text_style = text_style

transform instance-attribute

transform = transform

xml_id instance-attribute

xml_id = xml_id

z_index instance-attribute

z_index = z_index

__init__

__init__(
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None

Initialize a ShapeBase element.

Parameters:

Name	Type	Description	Default
name	str | None	Name of the graphical element.	None
style	str | None	The style name for the shape.	None
text_style	str | None	The text style name for the shape.	None
draw_id	str | None	The unique ID for the drawing shape.	None
layer	str | None	The drawing layer of the shape.	None
presentation_class	str | None	White-space-separated list of presentation class names.	None
presentation_style	str | None	Style for a presentation shape.	None
caption_id	str | None	Target ID assigned to the “draw:text-box” that contains the caption.	None
class_names	str | None	White-space-separated list of styles with the family value of graphic.	None
transform	str | None	White-space or comma separated list of transform definitions.	None
z_index	int | None	Rendering order for shapes in a document instance.	None
end_cell_address	str | None	End position of the shape if it is included in a spreadsheet document.	None
end_x	str | None	The x-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
end_y	str | None	The y-coordinate of the end position of a shape relative to the top-left edge of a cell.	None
table_background	bool | None	Wether the shape is in the table background if the drawing shape is included in a spreadsheet.	None
anchor_type	str | None	How a drawing shape is bound to a text document.	None
anchor_page	int | None	Physical page number of an anchor if the drawing object is bound to a page within a text document.	None
xml_id	str | None	The unique XML ID.	None

Source code in odfdo/shapes.py

def __init__(
    self,
    name: str | None = None,
    style: str | None = None,
    text_style: str | None = None,
    draw_id: str | None = None,
    layer: str | None = None,
    presentation_class: str | None = None,
    presentation_style: str | None = None,
    caption_id: str | None = None,
    class_names: str | None = None,
    transform: str | None = None,
    z_index: int | None = None,
    end_cell_address: str | None = None,
    end_x: str | None = None,
    end_y: str | None = None,
    table_background: bool | None = None,
    anchor_type: str | None = None,
    anchor_page: int | None = None,
    xml_id: str | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a ShapeBase element.

    Args:
        name: Name of the graphical element.
        style: The style name for the shape.
        text_style: The text style name for the shape.
        draw_id: The unique ID for the drawing shape.
        layer: The drawing layer of the shape.
        presentation_class: White-space-separated list of presentation
            class names.
        presentation_style: Style for a presentation shape.
        caption_id: Target ID assigned to the "draw:text-box" that
            contains the caption.
        class_names: White-space-separated list of styles with the
            family value of graphic.
        transform: White-space or comma separated list of transform
            definitions.
        z_index: Rendering order for shapes in a document instance.
        end_cell_address: End position of the shape if it is included
            in a spreadsheet document.
        end_x: The x-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        end_y: The y-coordinate of the end position of a shape relative
            to the top-left edge of a cell.
        table_background: Wether the shape is in the table background if
            the drawing shape is included in a spreadsheet.
        anchor_type: How a drawing shape is bound to a text document.
        anchor_page: Physical page number of an anchor if the drawing
            object is bound to a page within a text document.
        xml_id: The unique XML ID.
    """
    super().__init__(**kwargs)
    if self._do_init:
        if name:
            self.name = name
        if style:
            self.style = style
        if text_style:
            self.text_style = text_style
        if draw_id:
            self.draw_id = draw_id
        if layer:
            self.layer = layer
        if presentation_class:
            self.presentation_class = presentation_class
        if presentation_style:
            self.presentation_style = presentation_style
        if caption_id:
            self.caption_id = caption_id
        if class_names:
            self.class_names = class_names
        if transform:
            self.transform = transform
        if z_index is not None:
            self.z_index = z_index
        if end_cell_address:
            self.end_cell_address = end_cell_address
        if end_x:
            self.end_x = end_x
        if end_y:
            self.end_y = end_y
        if table_background is not None:
            self.table_background = table_background
        if anchor_type:
            self.anchor_type = anchor_type
        if anchor_page is not None:
            self.anchor_page = anchor_page
        if xml_id:
            self.xml_id = xml_id

get_formatted_text

get_formatted_text(context: dict | None = None) -> str

Return the formatted text content of the shape.

Parameters:

Name	Type	Description	Default
context	dict | None	A dictionary of context variables.	None

Returns:

Name	Type	Description
str	str	The formatted text content.

Source code in odfdo/shapes.py

def get_formatted_text(self, context: dict | None = None) -> str:
    """Return the formatted text content of the shape.

    Args:
        context: A dictionary of context variables.

    Returns:
        str: The formatted text content.
    """
    result: list[str] = []
    for child in self.children:
        result.append(child.get_formatted_text(context))
    result.append("\n")
    return "".join(result)