The Image component for Retool Mobile

A content area to display an image.

Demo

Settings

Image includes the following configurable options when building apps in the IDE.

CornersEvent handlersHiddenShow on desktopShow on mobileMaintain space when hiddenMarginFitRatioFile inputAlways show in edit modeSourceSourceStyles

Properties

All properties for Image with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

cornerType

enum

The corner style to use.

Values

square	Square corners.
round	Rounded corners.

---

dbBlobId

string

Self-hosted Retool deployments only. The ID of the uploaded image when srcType is dbBlobId.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

mode

enum

How to render images to fit.

Values

cover	Scale the image to fit the area while preserving the aspect ratio.
center	Center the image.
stretch	Resize the image to the same dimensions as the area.
contain	Scale and clip the image to fit the area while preserving the aspect ratio.

---

pluginType

string

The plugin type.

---

ratio

enum

The ratio of width-to-height.

Values

2	2:1 ratio.
1.3333333333333333	4:3 ratio.
1	1:1 ratio.
0.75	3:4 ratio.

---

retoolFileObject

object

The file's data when using a file not stored in Retool Storage.

---

retoolStorageDynamicInput

string

Whether retoolStorageFileId is set dynamically.

---

retoolStorageFileId

string

The Retool Storage file ID if srcType is retoolStorageFileId.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

src

string

The data source.

---

srcType

enum

The source type.

Values

url	URL.
retoolStorageFileId	Retool Storage file.
retoolFileObject	A file object.

---

storageBlobId

string

The ID of the uploaded image when srcType is storageBlobId.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

Methods

JavaScript API methods for interacting with Image. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

image.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

0

---

1

---

2

---

3

---

4

---