FreeformBuilder

Allows a freeform shape to be specified and created.

The initial pen position is provided on construction. From there, drawing proceeds using successive calls to draw line segments. The freeform shape may be closed by calling the :meth:close method.

A shape may have more than one contour, in which case overlapping areas are "subtracted". A contour is a sequence of line segments beginning with a "move-to" operation. A move-to operation is automatically inserted in each new freeform; additional move-to ops can be inserted with the .move_to() method.

FreeformBuilder(shapes: _BaseGroupShapes, start_x: Length, start_y: Length, x_scale: float, y_scale: float)

Attributes

`shape_offset_x`

attributeshape_offset_xLength

Return x distance of shape origin from local coordinate origin.

The returned integer represents the leftmost extent of the freeform shape, in local coordinates. Note that the bounding box of the shape need not start at the local origin.

`shape_offset_y`

attributeshape_offset_yLength

Return y distance of shape origin from local coordinate origin.

The returned integer represents the topmost extent of the freeform shape, in local coordinates. Note that the bounding box of the shape need not start at the local origin.

Functions

`getitem`

func__getitem__(idx: int) -> DrawingOperation

paramidxint

Returns

pptx.shapes.freeform.DrawingOperation

`iter`

func__iter__() -> Iterator[DrawingOperation]

Returns

typing.Iterator[pptx.shapes.freeform.DrawingOperation]

`len`

func__len__()

`add_line_segments`

funcadd_line_segments(vertices: Iterable[tuple[float, float]], close: bool = True)

Add a straight line segment to each point in vertices.

vertices must be an iterable of (x, y) pairs (2-tuples). Each x and y value is rounded to the nearest integer before use. The optional close parameter determines whether the resulting contour is closed or left open.

Returns this FreeformBuilder object so it can be used in chained calls.

paramverticesIterable[tuple[float, float]]

paramclosebool

= True

`convert_to_shape`

funcconvert_to_shape(origin_x: Length = Emu(0), origin_y: Length = Emu(0))

Return new freeform shape positioned relative to specified offset.

origin_x and origin_y locate the origin of the local coordinate system in slide coordinates (EMU), perhaps most conveniently by use of a Length object.

Note that this method may be called more than once to add multiple shapes of the same geometry in different locations on the slide.

paramorigin_xLength

= Emu(0)

paramorigin_yLength

= Emu(0)

`move_to`

funcmove_to(x: float, y: float)

Move pen to (x, y) (local coordinates) without drawing line.

Returns this FreeformBuilder object so it can be used in chained calls.

paramxfloat

paramyfloat

`new`

funcnew(shapes: _BaseGroupShapes, start_x: float, start_y: float, x_scale: float, y_scale: float)

Return a new FreeformBuilder object.

The initial pen location is specified (in local coordinates) by (start_x, start_y).

paramshapes_BaseGroupShapes

paramstart_xfloat

paramstart_yfloat

paramx_scalefloat

paramy_scalefloat

On this page