The Image component for Retool Apps
A content area to display an image.
Settings
Image includes the following configurable options when building apps in the IDE.
| Show on desktopShow on mobileMaintain space when hiddenMarginAlways 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.
aspectRatio
The ratio of width-to-height (e.g., 1.3 to use 4:3 ratio).
clickable
Whether there is an enabled Click event handler.
dbBlobId
Self-hosted Retool deployments only. The ID of the uploaded image when srcType is dbBlobId.
Properties
event
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 |
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
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). |
Values
cover | Crop the image to fit the width. |
contain | Scale the image to fill the width. |
flipHorizontal
Whether the image is flipped horizontally.
flipVertical
Whether the image is flipped vertically.
global
Whether the object is globally scoped for use in all app pages.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
horizontalAlign
The horizontal alignment of the contents.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
stretched | Justified alignment |
id
The unique identifier.
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.
pluginType
The plugin type.
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.
Whether to show legacy files in the file picker.
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.
tooltipText
The tooltip text to display.
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.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
image.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setFlipHorizontal
Set the flipHorizontal value to toggle whether the component is flipped horizontally.
image.setFlipHorizontal(flipHorizontal)
Parameters
flipHorizontal
Whether the image is flipped horizontally.
setFlipVertical
Set the flipVertical value to toggle whether the component is flipped vertically.
image.setFlipVertical(flipVertical)
Parameters
flipVertical
Whether the image is flipped vertically.
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.
click
The item is clicked or pressed.