pdftools_toolbox.pdf.annotations.polygon_annotation

Classes

PolygonAnnotation(handle)

A polygon annotation

class pdftools_toolbox.pdf.annotations.polygon_annotation.PolygonAnnotation(handle)

Bases: DrawingAnnotation

A polygon annotation

static create(target_document: Document, path: Path, stroke: Stroke | None, fill: Paint | None) → PolygonAnnotation

Create a polygon annotation.

The returned polygon annotation is not yet part of any page. It can be added to a page’s list of annotations.

Parameters:

• targetDocument (pdftools_toolbox.pdf.document.Document) – The output document with which the returned object is associated.

• path (pdftools_toolbox.pdf.content.path.Path) – The path of the polygon.

• stroke (Optional[pdftools_toolbox.pdf.content.stroke.Stroke]) – The stroking parameters used for stroking the polygon. The stroking paint is used as the annotation’s main paint. If None then the polygon is not filled.

• fill (Optional[pdftools_toolbox.pdf.content.paint.Paint]) – The paint used for filling the polygon. If None then the polygon is not filled.

Returns:

The newly created polygon annotation.

Return type:

pdftools_toolbox.pdf.annotations.polygon_annotation.PolygonAnnotation

Raises:

• ValueError – if the targetDocument has already been closed

• ValueError – if the targetDocument is read-only

• ValueError – if the path argument has not been constructed with a pdftools_toolbox.pdf.content.path_generator.PathGenerator

• ValueError – if the targetDocument’s conformance is not PDF 2.0 and the path argument contains curve-to operations

• ValueError – if the path argument contains close-subpath or rectangle operations

• pdftools_toolbox.unsupported_feature_error.UnsupportedFeatureError – if the targetDocument’s conformance is PDF 2.0 and the path argument contains curve-to operations

• ValueError – if the stroke and fill arguments are both None

• ValueError – if the stroke argument is not associated with targetDocument

• ValueError – if the stroke’s pdftools_toolbox.pdf.content.stroke.Stroke.paint has a pdftools_toolbox.pdf.content.paint.Paint.color_space other than a device color space

• ValueError – if the stroke’s pdftools_toolbox.pdf.content.stroke.Stroke.paint has a non-Nonepdftools_toolbox.pdf.content.paint.Paint.transparency with pdftools_toolbox.pdf.content.transparency.Transparency.blend_mode other than pdftools_toolbox.pdf.content.blend_mode.BlendMode.NORMAL

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.line_cap_style is other than pdftools_toolbox.pdf.content.line_cap_style.LineCapStyle.BUTT

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.line_join_style is other than pdftools_toolbox.pdf.content.line_join_style.LineJoinStyle.MITER

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.miter_limit is other than 10

• ValueError – if the stroke argument’s pdftools_toolbox.pdf.content.stroke.Stroke.dash_phase is other than 0

• ValueError – if the fill has a pdftools_toolbox.pdf.content.paint.Paint.color_space other than a device color space

• ValueError – if the fill has a non-Nonepdftools_toolbox.pdf.content.paint.Paint.transparency with pdftools_toolbox.pdf.content.transparency.Transparency.blend_mode other than pdftools_toolbox.pdf.content.blend_mode.BlendMode.NORMAL

• ValueError – if the fill argument is not associated with the targetDocument

• pdftools_toolbox.conformance_error.ConformanceError – if the explicitly requested PDF conformance is smaller than PDF 1.5

property fill: Paint

The filling paint

Returns:

pdftools_toolbox.pdf.content.paint.Paint

Raises:

StateError – if the object has already been closed