Paper Office
paper-docxAPI referenceoxml.shape

CT_Picture

paper-docx 0.2.0 API reference

<pic:pic> element, a DrawingML picture.

Attributes

blipFill

attributeblipFillCT_BlipFillProperties
= OneAndOnlyOne('pic:blipFill')

nvPicPr

attributenvPicPrCT_PictureNonVisual
= OneAndOnlyOne('pic:nvPicPr')

spPr

attributespPrCT_ShapeProperties
= OneAndOnlyOne('pic:spPr')

xml

attributexmlstr

XML string for this element, suitable for testing purposes.

Pretty printed for readability and without an XML declaration at the top.

Functions

first_child_found_in

funcfirst_child_found_in(*tagnames: str) -> _Element | None

First child with tag in tagnames, or None if not found.

paramtagnamesstr
= ()

Returns

lxml.etree._Element | None

insert_element_before

funcinsert_element_before(elm: ElementBase, *tagnames: str)
paramelmElementBase
paramtagnamesstr
= ()

new

funcnew(pic_id: int, filename: str, rId: str, cx: Length, cy: Length) -> CT_Picture

A new minimum viable <pic:pic> (picture) element.

parampic_idint
paramfilenamestr
paramrIdstr
paramcxLength
paramcyLength

Returns

docx.oxml.shape.CT_Picture

remove_all

funcremove_all(*tagnames: str) -> None

Remove child elements with tagname (e.g. "a:p") in tagnames.

paramtagnamesstr
= ()

Returns

None

xpath

funcxpath(xpath_str: str) -> Any

Override of lxml _Element.xpath() method.

Provides standard Open XML namespace mapping (nsmap) in centralized location.

paramxpath_strstr

Returns

typing.Any

On this page