The Image component for classic apps

A content area to display an image.

Classic apps

You're viewing documentation for classic apps, which use Retool's original app editor. The new app builder is the recommended way to build apps and where Retool focuses new development.

Demo

Properties

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

altText

An accessible description for screen readers.

Type	string
Format	Plain Text
Configurability	Inspector
Default	null

Examples

false"Retool logo."

---

aspectRatio

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

Type	number
Format	Float
Configurability	Inspector
Default	null

Examples

false1.3

---

clickable

Whether there is an enabled Click event handler.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Event handlers
Default	false

Examples

falsetrue

---

dbBlobId

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

Type	string
Configurability	Read-only
Default	null

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).
Default	null

---

---

fit

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

Type	string
Configurability	Inspector
Allowed Values	Value Description cover Crop the image to fit the width. contain Scale the image to fill the width.
Default	null

---

flipHorizontal

Whether the image is flipped horizontally.

Type	boolean
Configurability	Inspector
Default	null

---

flipVertical

Whether the image is flipped vertically.

Type	boolean
Configurability	Inspector
Default	null

---

heightType

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

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Height
Allowed Values	Value Description fixed Fixed height. auto Expand to fit content.
Default	fixed

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

falsetrue

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Configurability	Inspector > Appearance > Align
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	image1

Examples

falsequery1

falsebutton1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

falsetrue

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

falsetrue

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

falsetrue

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

false4px 8px

---

retoolFileObject

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

Type	object
Configurability	Read-only
Default	null

Object Properties

base64Data

The base64 encoded data of the file.

Type	string
Configurability	Read-only
Default	null

---

sizeBytes

The size of the file in bytes.

Type	number
Configurability	Read-only
Default	null

---

type

The MIME type.

Type	string
Configurability	Read-only
Default	null

---

name

The file name.

Type	string
Configurability	Read-only
Default	null

---

Examples

false{
  "name": "sample.pdf",
  "type": "application/pdf",
  "sizeBytes": 10523,
  "base64Data": "JVBERi0xLjQKJeLjz9...G"
}

---

retoolStorageDynamicInput

Whether retoolStorageFileId is set dynamically.

Type	string
Configurability	Read-only
Default	null

---

retoolStorageFileId

The unique identifier for a file in Retool Storage.

Type	string
Format	UUID
Configurability	Inspector > Content > File input
Default	null

---

retoolStorageShowLegacyFiles

Whether to show legacy files in the file picker.

Type	boolean
Configurability	Inspector
Default	null

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

falsetrue

---

src

The data source.

Type	string
Format	string
Configurability	Inspector
Default	null

Examples

falsehttps://upload.wikimedia.org/wikipedia/commons/1/14/Marspathfinder.pdf

---

srcHeight

The height.

Type	number
Configurability	Inspector
Default	null

---

srcType

The source type.

Type	string
Configurability	Inspector
Allowed Values	Value Description src URL. retoolStorageFileId Retool Storage file. retoolFileObject Retool file object. dbBlobId Database blob. storageBlobId Storage blob.
Default	null

---

srcWidth

The width of the image.

Type	number
Configurability	Inspector
Default	null

---

storageBlobId

The ID of the uploaded image when srcType is storageBlobId.

Type	string
Format	Blob URI
Configurability	Read-only
Default	null

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

image.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

image.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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.

---

---

Examples

Scroll the minimum amount to immediately bring image into view.

image.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

image.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

image.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable image.

image.setDisabled(true);

Enable image.

image.setDisabled(false);

---

image.setFlipHorizontal()

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

Definition

image.setFlipHorizontal(flipHorizontal)

Parameters

flipHorizontal

Whether the image is flipped horizontally.

Type

boolean

---

---

image.setFlipVertical()

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

Definition

image.setFlipVertical(flipVertical)

Parameters

flipVertical

Whether the image is flipped vertically.

Type

boolean

---

---

image.setHidden()

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

Definition

image.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide image.

image.setHidden(true);

Unhide image.

image.setHidden(false);

---

image.setImageUrl()

Set the URL of the image.

Definition

image.setImageUrl(src)

Parameters

src

The data source.

Type	string
Format	string

Examples

https://upload.wikimedia.org/wikipedia/commons/1/14/Marspathfinder.pdf

---

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Click	An item is clicked or pressed.