The Image mobile component
A content area to display an image.
Settings
Image includes the following configurable options when building apps in the IDE.
| Content | File inputSourceSource |
| Interaction | Event handlers |
| Appearance | CornersShow on desktopShow on mobileMaintain space when hiddenMarginFitRatioAlways show in edit modeStyles |
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
The corner style to use.
Values
square | Square corners. |
round | Rounded corners. |
dbBlobId
Self-hosted Retool deployments only. The ID of the uploaded image when srcType is dbBlobId.
Properties
event
The event type.
Values
0
A user changes the value.
1
A user clicks or taps the component.
2
A user submits the value.
3
A user selects the input field.
4
A user deselects the input field.
5
A user scans a barcode.
6
A user opens the component.
7
A user closes the component.
8
A user sets the value to true.
9
A user sets the value to false.
10
A user selects a value.
11
A user clears the value.
12
A user uploads a file.
13
An uploaded file is parsed.
14
A user changes the value of the input field.
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
0
Control query.
1
Control component.
2
Run script.
3
Set variable.
4
Set localStorage.
5
Perform utility action (e.g., Open URL or Confetti).
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). |
id
The name.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
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
The plugin type.
Values
2 | 2:1 ratio. |
1.3333333333333333 | 4:3 ratio. |
1 | 1:1 ratio. |
0.75 | 3:4 ratio. |
retoolFileObject
The file's data when using a file not stored in Retool Storage.
retoolStorageDynamicInput
Whether retoolStorageFileId is set dynamically.
retoolStorageFileId
The Retool Storage file ID if srcType is retoolStorageFileId.
showInEditor
Whether to remain visible in the editor if hidden is true.
Values
url | URL. |
retoolStorageFileId | Retool Storage file. |
retoolFileObject | A file object. |
storageBlobId
The ID of the uploaded image when srcType is storageBlobId.
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
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.