WebP#

Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).


import panel as pn

pn.extension()

The WebP pane embeds a .web image file in a panel if provided a local path, or will link to a remote image if provided a URL.

Parameters:#

For details on other options for customizing the component see the layout and styling how-to guides.

  • alt_text (str, default=None): alt text to add to the image tag. The alt text is shown when a user cannot load or display the image.

  • embed (boolean, default=False): If given a URL to an image this determines whether the image will be embedded as base64 or merely linked to.

  • fixed_aspect (boolean, default=True): Whether the aspect ratio of the image should be forced to be equal.

  • link_url (str, default=None): A link URL to make the image clickable and link to some other website.

  • object (str or object): The PNG file to display. Can be a string pointing to a local or remote file, or an object with a _repr_png_ method.

  • style (dict): Dictionary specifying CSS styles


The WebP pane can be pointed at any local or remote .webp file. If given a URL starting with http or https, the embed parameter determines whether the image will be embedded or linked to:

webp_pane = pn.pane.WebP('https://assets.holoviz.org/panel/samples/webp_sample.webp')

webp_pane

We can scale the size of the image by setting a specific fixed width or height:

webp_pane.clone(width=400)

Alternatively we can scale the width and height using the sizing_mode:

pn.pane.WebP(
    'https://assets.holoviz.org/panel/samples/webp_sample2.webp', sizing_mode='scale_width'
)

Note that by default the aspect ratio of the image is fixed, and so there may be a gap beside or below the image even in responsive sizing modes. To override this behavior set fixed_aspect=False or provide fixed width and height values.


Open this notebook in Jupyterlite | Download this notebook from GitHub (right-click to download).