Skip to main content

Image

The Image widget displays raster images such as PNG and JPG on screen.
It loads images from a range of sources — assets (project resources), the network (URL), or a file — and draws them with the size, fit, and alignment you specify.

Definition and role

The Image widget reads the image source you specify and draws it on screen. If the image is missing or fails to load, it shows the placeholder image instead. Configure the size (width, height), fit, alignment, repeat, and color filter as needed.

  • Category: Contents
  • Supported image sources (pick one in the image property): assetImage (a project asset — automatically picks the resolution variant that matches the screen scale), exactAssetImage (loads a project asset at exactly the path and scale you give), networkImage (a remote image over URL), fileImage (a device file path). Default assetImage
  • Default image source: an empty asset (you need to set one)

Features

FeatureDescription
Image displayDraws asset, network (URL), and file images on screen.
Placeholder imageShows the fallback image set in placeholder when the image is missing or fails to load.
Size and fitAdjust the display area with the width, height, and fit (how the image fills the area).
Color filterTints the image with color and colorBlendMode.
Repeat and alignmentTiles the image with repeat and positions it with alignment.

How to use

  1. Open the Contents category in the left widget palette.
  2. Drag and drop the Image item onto the canvas.
  3. In the property panel on the right, set image to the image source you want to show — an asset, a URL, or a file.
  4. Adjust the size and fit with width, height, and fit if needed.
  5. Set placeholder to a fallback image in case loading fails.

Properties

PropertyDescriptionDefaultValue / type
imageThe image source to display. Pick the source kind from assetImage, exactAssetImage, networkImage, or fileImage, then point it at the source to load.An empty asset (you need to set one)Image source
placeholderName of the fallback image asset shown when the image is missing or fails to loadNot setString (asset name)
SizeImage size — a grouped property that sets the width and height togetherNot setSize (width and height, number in px)
colorThe color layered over the imageNot setColor
colorBlendModeHow color blends with the imageNot setBlend mode
fitHow the image fills the display areaNot setfill, contain, cover, fitWidth, fitHeight, none, scaleDown
alignmentImage alignment inside the display areaCenterAlignment value
repeatHow the image repeatsnoRepeat
(no repeat)
repeat, repeatX, repeatY, noRepeat
centerSliceThe center area stretched by 9-slice scalingNot setRectangular area
matchTextDirectionFlips the image to match the text directionfalseTrue/false
gaplessPlaybackKeeps the previous image while a new one loads to prevent flickerfalseTrue/false
isAntiAliasApplies anti-aliasing to smooth edges — this does not work in the current version.falseTrue/false
filterQualityImage scaling qualitylownone, low, medium, high
semanticLabelDescription read by accessibility screen readersNot setString
excludeFromSemanticsExcludes the widget from accessibility informationfalseTrue/false

Notes and tips

warning

If you leave image unset or the source cannot be found, no image appears. In that case the fallback image set in placeholder is shown instead.

tip

Network (URL) images automatically fall back to the placeholder image while loading and when loading fails. Asset images use the name of a resource registered in the project.

Learn more

tip

For the full set of Widget Controls (Property, Method, Event) that let you drive this widget from a script, visit Image Widget Control.