Skip to content

DisplayImage

What is it?

The DisplayImage node displays an image and provides its dimensions. It's a simple viewer that shows an image in your workflow while also extracting useful information like width and height.

When would I use it?

Use this node when you want to:

  • Display an image in your workflow for visual feedback
  • Get the dimensions (width and height) of an image
  • Pass an image through your workflow while viewing it
  • Debug your workflow by seeing what image is being processed

How to use it

Basic Setup

  1. Add the DisplayImage node to your workflow
  2. Connect an image source to the "image" input
  3. The image will be displayed and its dimensions will be available as outputs (note: They are hidden by default. You can display them in the Properties panel on the right.)

Parameters

  • image: The image to display

Outputs

  • image: The same image that was input, passed through for use by other nodes
  • width: The width of the image in pixels (integer)
  • height: The height of the image in pixels (integer)

Example

A common workflow pattern:

  1. Connect an image source (like GenerateImage or LoadImage) to the DisplayImage node
  2. View the image in the DisplayImage node to confirm it's what you expected
  3. Use the width and height outputs if you need the image dimensions for other nodes
  4. Connect the image output to other nodes that need the image

Important Notes

  • The DisplayImage node passes the image through unchanged - it's purely for display and dimension extraction
  • For ImageUrlArtifact inputs, the node will fetch the image from the URL to determine dimensions
  • For ImageArtifact inputs, dimensions are read directly from the artifact's properties
  • The width and height outputs are hidden from the UI by default, but can be enabled in the Properties Panel.

Common Issues

  • Image not displaying: Check that your image source is properly connected and producing valid image data
  • Dimensions showing as 0: This may indicate an issue with the image data or connection
  • Slow performance with URLs: Large images from URLs may take time to fetch and process for dimension calculation