Python > Figure Reference > layout.images

Python Figure Reference: layout.images

  • images
    Code: fig.update_layout_images(...)
    Type: list of dict where each dict has one or more of the keys listed below.
    • layer
      Code: fig.update_layout_images(layer=<VALUE>)
      Type: enumerated , one of ( "below" | "above" )
      Default: "above"

      Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area.

    • name
      Code: fig.update_layout_images(name=<VALUE>)
      Type: string

      When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: False` or `enabled: False` to hide it). Has no effect outside of a template.

    • opacity
      Code: fig.update_layout_images(opacity=<VALUE>)
      Type: number between or equal to 0 and 1
      Default: 1

      Sets the opacity of the image.

    • sizex
      Code: fig.update_layout_images(sizex=<VALUE>)
      Type: number
      Default: 0

      Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width. When `xref` ends with ` domain`, units are sized relative to the axis width.

    • sizey
      Code: fig.update_layout_images(sizey=<VALUE>)
      Type: number
      Default: 0

      Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height. When `yref` ends with ` domain`, units are sized relative to the axis height.

    • sizing
      Code: fig.update_layout_images(sizing=<VALUE>)
      Type: enumerated , one of ( "fill" | "contain" | "stretch" )
      Default: "contain"

      Specifies which dimension of the image to constrain.

    • source
      Code: fig.update_layout_images(source=<VALUE>)
      Type: string

      Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute.

    • templateitemname
      Code: fig.update_layout_images(templateitemname=<VALUE>)
      Type: string

      Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: False` or `enabled: False` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: True`.

    • visible