set_image method

set_image(stream)

Sets the image that the shape displays.

def set_image(self, stream: io.BytesIO):
    ...

Parameter	Type	Description
stream	io.BytesIO	The stream that contains the image.

set_image(file_name)

Sets the image that the shape displays.

def set_image(self, file_name: str):
    ...

Parameter	Type	Description
file_name	str	The image file. Can be a file name or a URL.

Examples

Shows how to display images from the local file system in a document.

doc = aw.Document()

# To display an image in a document, we will need to create a shape
# which will contain an image, and then append it to the document's body.
img_shape = None

# Below are two ways of getting an image from a file in the local file system.
# 1 -  Create an image object from an image file:
with drawing.Image.from_file(IMAGE_DIR + "Logo.jpg") as src_image:

    img_shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.IMAGE)
    doc.first_section.body.first_paragraph.append_child(img_shape)
    img_shape.image_data.set_image(src_image)

# 2 -  Open an image file from the local file system using a stream:
with open(IMAGE_DIR + "Logo.jpg", "rb") as stream:

    img_shape = aw.drawing.Shape(doc, aw.drawing.ShapeType.IMAGE)
    doc.first_section.body.first_paragraph.append_child(img_shape)
    img_shape.image_data.set_image(stream)
    img_shape.left = 150.0

doc.save(ARTIFACTS_DIR + "Drawing.import_image.docx")

Shows how to insert a linked image into a document.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

image_file_name = IMAGE_DIR + "Windows MetaFile.wmf"

# Below are two ways of applying an image to a shape so that it can display it.
# 1 -  Set the shape to contain the image.
shape = aw.drawing.Shape(builder.document, aw.drawing.ShapeType.IMAGE)
shape.wrap_type = aw.drawing.WrapType.INLINE
shape.image_data.set_image(image_file_name)

builder.insert_node(shape)

doc.save(ARTIFACTS_DIR + "Image.create_linked_image.embedded.docx")

# Every image that we store in shape will increase the size of our document.
self.assertLess(70000, os.path.getsize(ARTIFACTS_DIR + "Image.create_linked_image.embedded.docx"))

doc.first_section.body.first_paragraph.remove_all_children()

# 2 -  Set the shape to link to an image file in the local file system.
shape = aw.drawing.Shape(builder.document, aw.drawing.ShapeType.IMAGE)
shape.wrap_type = aw.drawing.WrapType.INLINE
shape.image_data.source_full_name = image_file_name

builder.insert_node(shape)
doc.save(ARTIFACTS_DIR + "Image.create_linked_image.linked.docx")

# Linking to images will save space and result in a smaller document.
# However, the document can only display the image correctly while
# the image file is present at the location that the shape's "source_full_name" property points to.
self.assertGreater(10000, os.path.getsize(ARTIFACTS_DIR + "Image.create_linked_image.linked.docx"))

See Also

• module aspose.words.drawing
• class ImageData