Shapes in spreadsheet document Leave feedback
On this page
Watermarker.get_content() returns a SpreadsheetContent whose worksheets each expose a shapes collection (along with charts, attachments, and background_image). You can iterate the shapes to read their properties, modify them, or remove them.
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def extract_shapes():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
content = watermarker.get_content()
for i, worksheet in enumerate(content.worksheets):
print(f"Worksheet {i}: shapes={len(worksheet.shapes)}")
for shape in worksheet.shapes:
text = (shape.text or "").strip()
print(f" shape text={text!r} size={round(shape.width)}x{round(shape.height)} "
f"word_art={shape.is_word_art}")
if __name__ == "__main__":
extract_shapes()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Worksheet 0: shapes=0
Worksheet 1: shapes=0
Each shape exposes text, image, name, alternative_text, x, y, width, height, rotate_angle, and is_word_art.
The shapes collection supports remove_at(index) and remove(shape). Iterate in reverse when removing by index:
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options.spreadsheet import SpreadsheetLoadOptions
def remove_and_modify_shapes():
with Watermarker("./spreadsheet.xlsx", SpreadsheetLoadOptions()) as watermarker:
content = watermarker.get_content()
for worksheet in content.worksheets:
for i in range(len(worksheet.shapes) - 1, -1, -1):
if worksheet.shapes[i].text == "CONFIDENTIAL":
worksheet.shapes.remove_at(i)
watermarker.save("./output.xlsx")
if __name__ == "__main__":
remove_and_modify_shapes()
spreadsheet.xlsx is the sample file used in this example. Click here to download it.
Binary file (XLSX, 9 KB)
You can replace a shape’s text by assigning to shape.text, replace its image by assigning a SpreadsheetWatermarkableImage to shape.image, set a hyperlink via shape.hyperlink, and modify its position and size.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
