Paper Office
paper-xlsxAPI referencepreserve.images

openpyxl.preserve.images

paper-xlsx 0.2.1 API reference

Replace one drawing relationship without rewriting the drawing.

plan_replacements

funcplan_replacements(zin, requests, part_plan, names, plan)

Add replacement media parts and retarget their relationships.

paramzinzipfile.ZipFile

Open workbook package.

paramrequestsmapping

Validated replacement requests keyed by image identity.

parampart_planopenpyxl.preserve.lifecycle.PartPlan

Package lifecycle plan to update.

paramnamesbuiltins.set[str]

Part names present in the package.

paramplandict

Planned replacement bytes keyed by part name.

Returns

None

None.

request_replacement

funcrequest_replacement(ws, target, replacement, *, name=None)

Validate and record one relationship-owned image replacement.

paramwsopenpyxl.worksheet.worksheet.Worksheet

Worksheet containing the loaded image.

paramtargetopenpyxl.drawing.image.Image | str

Loaded image or its anchor coordinate.

paramreplacementopenpyxl.drawing.image.Image | path - like

Replacement image or image source.

paramnamestr | None
= None

Optional image name used to resolve an ambiguous anchor.

Returns

openpyxl.drawing.image.Image

The loaded image selected for replacement.

On this page