Skip to main content

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.

An accessible description for screen readers.


The ratio of width-to-height (e.g., 1.3 to use 4:3 ratio).


clickable

boolean

Whether there is an enabled Click event handler.


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.


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).



fit

enum

Whether the image is cropped to fit or scaled to fill the width if heightType is fixed.

Values
cover

Crop the image to fit the width.

contain

Scale the image to fill the width.


flipHorizontal

boolean

Whether the image is flipped horizontally.


flipVertical

boolean

Whether the image is flipped vertically.


global

boolean

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


Whether the height automatically resizes to fit content or is a fixed size.

Values
fixed

Fixed height.

auto

Expand to fit content.


boolean

Whether the component is visible.


The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretched

Justified alignment


id

string

The unique identifier.


Whether the component is visible in the desktop layout.


Whether the component is visible in the mobile layout.


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


The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.


pluginType

string

The plugin type.


retoolFileObject

object

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


retoolStorageDynamicInput

string

Whether retoolStorageFileId is set dynamically.


The Retool Storage file ID if srcType is retoolStorageFileId.


Whether to show legacy files in the file picker.


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


src

string

The data source.


The height.


The source type.

Values
url

URL.

retoolStorageFileId

Retool Storage file.

retoolFileObject

A file object.


The width of the image.


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.


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

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

enum

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.

image.setDisabled(disabled)
Parameters

Whether input, interaction, selection, or triggering is disabled.



setFlipHorizontal

Set the flipHorizontal value to toggle whether the component is flipped horizontally.

image.setFlipHorizontal(flipHorizontal)
Parameters

flipHorizontal

boolean

Whether the image is flipped horizontally.



setFlipVertical

Set the flipVertical value to toggle whether the component is flipped vertically.

image.setFlipVertical(flipVertical)
Parameters

flipVertical

boolean

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

boolean

Whether the component is visible.



setImageUrl

Set the URL of the image.

image.setImageUrl(src)
Parameters

src

string

The data source.



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.