Skip to content

Image renderer

ImageRendererBasic

Bases: ImageRendererBase

Simply adds the image and the caption below it.

Attributes:

Returns:

Type Description

ImageRendererBasic Instance

Examples:

1
render_basic = ImageRendererBasic()

ImageRendererExpandable

Bases: ImageRendererBase

Adds an expandable container with the image and caption. The container can be expanded/minimized by clicking on the expand button of the container.

Attributes:

Name Type Description
is_expanded bool

Set to False if you want the container to be minimized by default. Default = True.

Returns:

Type Description

ImageRendererExpandable Instance

Examples:

1
render_expandable = ImageRendererExpandable(is_expanded=False)

Bases: ImageRendererBase

Adds a clickable link to the report. When clicked, a pop-up opens with the image and caption.

Attributes:

Name Type Description
display_text str

The text content of the link. Default = "Click here to open the image".

Returns:

Type Description

ImageRendererLink Instance

Examples:

1
render_link = ImageRendererLink(display_text="Please click here to open the image!")